Barbara Kendrick's Blog
Your GitHub profile is an extremely important aspect of your public identity as a developer. A well-crafted one allows you to show off your work to other developers as well as potential employers. An important component of your GitHub profile—and one that many new developers often overlook—is the README.md file.
The quality of a README often differentiates a good project from a bad project. A good one takes advantage of the opportunity to explain and showcase what your application does, justify the technologies used, and even talk about some of the challenges you faced and features you hope to implement in the future. A good README helps you stand out among the large crowd of developers putting their work on GitHub.
There's no one right way to structure a good README. There is one very wrong way, however, and that is to not include a README at all or to create a very anemic one. This guide outlines a few best practices. As you progress in your career, you will develop your own ideas about what makes a good README.
At a minimum, your project README needs a title and a short description explaining the what, why, and how. What was your motivation? Why did you build this project? (Note: The answer is not "Because it was a homework assignment.") What problem does it solve? What did you learn? What makes your project stand out? If your project has a lot of features, consider adding a heading called "Features" and listing them here.
If you're new to Markdown, read the GitHub guide on Mastering Markdown.
If you need an example of a good README, check out the VSCode repository.
- Installation
- Usage
- User Story
- Acceptance Criteria
- Credits
- License
- Badges
- Contributing
- Test
- Wire-Frame
- Updates
- Review
- Project Links
- Connect with Me
Acceptance Criteria
What are the steps required to install your project? Provide a step-by-step description of how to get the development environment running.
Provide instructions and examples for use. Include screenshots as needed.
RESTful API
** 7 Routes **
View
* GET /user View all users (R)
* GET /user/:id Single user (R)
* GET /user/edit/:id PrePopulated Form of users (R)
* GET /user/new Empty Form
API Routes
* POST /user (C)
* PUT /user/:id (U)
* DELETE /user/:id (D)
Admin Pages
* GET /AdminUsers (R)
* PUT /AdminUsers/Edit (U)
* DELETE /AdminUsers (D)
* POST /AdminNewUser (C)
GIVEN a
WHEN I
THEN I
List your collaborators, if any, with links to their GitHub profiles.
If you used any third-party assets that require attribution, list the creators with links to their primary web presence in this section.
If you followed tutorials, include links to those here as well.
https://github.com/dagreatcode/Fashion-Passion
https://dagreatcode.github.io/Fashion-Passion/
https://rapidapi.com/OmbreRapid/api/ombre-ai-fashion-size-recommendation/
https://rapidapi.com/chicmi/api/chicmi-local-fashion/
https://rapidapi.com/api4ai-api4ai-default/api/fashion4/
https://rapidapi.com/lenewblack/api/le-new-black/
https://rapidapi.com/apidojo/api/kohls/
MIT License
Copyright (c) 2022 Vincent Kendrick
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
🏆
If you created an application or package and would like other developers to contribute it, you will want to add guidelines for how to do so. The Contributor Covenant is an industry standard, but you can always write your own.
Go the extra mile and write tests for your application. Then provide examples on how to run them.
---
© 2022 DaGreat Code LLC. All Rights Reserved.