Project Checklist
Mostly for take home challenges, but also for any project that you want to. A list of things to make sure you have handled before submitting your project.
- Use semantic HTML tags
- Use ARIA attributes where appropriate - ARIA Make accessibility improvements
- If using CSS/SCSS, use some naming convention (BEM)
- Make sure your design is responsive
- Add testing structure, write unit tests at least
- Add linting and prettier structure
- Consider adding CI/CD structure of sorts, pre/post commit hooks are good
- Add a README.md file - You can include images of test coverage or screenshots of the app. Describe decisions you made, and why you made them. If you used a particular design pattern or library, explain why. If you had to make any trade-offs, explain those as well.
- Follow best practices in the framework you are using. Utilise DRY and KISS principles wherever you can.
- Consider performance. For React, reduce number of rerenders. Follow the Performance section in the docs.
- Add meaningful commit messages, with a naming convention