0
showcase
Shipped: A guide for the next contributor
Documentation Requirements – Contributor Guide
1. A
CONTRIBUTING.md file has been added to the repository.
2. The project structure is explained, including the purpose of the main folders and files.
3. The documentation explains where new features should be added.
4. Guidance is provided on which existing components may need to be updated when adding a feature.
5. Instructions are included for installing dependencies and running the project locally.
6. The commands for building and linting the project are documented.
7. Expected results of successful build and lint checks are explained.
8. Fragile parts of the code are identified, including ingredient calculations, serving controls, accessibility announcements, and responsive layout.
9. The README includes information about the project, its main features, technologies, and how to run it locally.
10. The documentation provides clear guidance to help future contributors understand and extend the project without breaking existing functionality.
Repository: https://github.com/humaeidmansur/accessible-recipe.git
Live: https://humaeid-internship-reciepe-project.netlify.app/
Built for the Verified Frontend Internship · DocumentationAdd a comment
0/2000