generated from nhcarrigan/template
naomi
b718aa650b
### Explanation _No response_ ### Issue _No response_ ### Attestations - [ ] I have read and agree to the [Code of Conduct](https://docs.nhcarrigan.com/community/coc/) - [ ] I have read and agree to the [Community Guidelines](https://docs.nhcarrigan.com/community/guide/). - [ ] My contribution complies with the [Contributor Covenant](https://docs.nhcarrigan.com/dev/covenant/). ### Dependencies - [ ] I have pinned the dependencies to a specific patch version. ### Style - [ ] I have run the linter and resolved any errors. - [ ] My pull request uses an appropriate title, matching the conventional commit standards. - [ ] My scope of feat/fix/chore/etc. correctly matches the nature of changes in my pull request. ### Tests - [ ] My contribution adds new code, and I have added tests to cover it. - [ ] My contribution modifies existing code, and I have updated the tests to reflect these changes. - [ ] All new and existing tests pass locally with my changes. - [ ] Code coverage remains at or above the configured threshold. ### Documentation _No response_ ### Versioning _No response_ Reviewed-on: #17 Co-authored-by: Naomi Carrigan <commits@nhcarrigan.com> Co-committed-by: Naomi Carrigan <commits@nhcarrigan.com>
3.1 KiB
3.1 KiB
title
| title |
|---|
| Final Polish Checklist |
COMPREHENSIVE CHECKLIST FOR PROJECT FINAL POLISH
Use this checklist to ensure your flagship project is ready for professional presentation.
Code Quality
- All code follows project style guide
- Code is clean, readable, and well-organised
- No commented-out code or debugging statements
- Error handling is comprehensive
- Code is properly commented where necessary
- All functions and methods are appropriately sized
Testing
- Comprehensive test coverage
- All tests are passing
- Tests are meaningful and test actual behavior
- Edge cases are covered by tests
- CI/CD pipeline is configured and passing
Documentation
- README.md is complete and professional
- Project description
- Features list
- Installation instructions
- Usage instructions
- Screenshots or demo links (if applicable)
- Technology stack
- Contributing guidelines link
- CONTRIBUTING.md is complete
- Development setup instructions
- Code style guidelines
- Pull request process
- Testing requirements
- LICENSE.md is present and appropriate
- Code comments are clear and helpful
- API documentation is complete (if applicable)
Security
- No sensitive data in code or configuration
- Environment variables are used for secrets
- Dependencies are up to date
- Security best practices are followed
- Authentication/authorization is properly implemented (if applicable)
Deployment
- Application is deployed and live
- Deployment is automated (CI/CD)
- Environment variables are properly configured
- Application is accessible and functional
- Domain is configured (optional but recommended)
User Experience (if applicable)
- Application is intuitive and easy to use
- Error messages are clear and helpful
- Loading states are handled appropriately
- Responsive design works on all screen sizes
- Accessibility standards are met
Performance
- Application loads quickly
- No obvious performance bottlenecks
- Database queries are optimized (if applicable)
- Images and assets are optimized
- Caching is implemented where appropriate
Project Organization
- Repository structure is clean and logical
- Files are properly organised
- Git history is clean and meaningful
- Issues are properly labelled and organised
- Project board is organised (if used)
Professional Presentation
- Project can be confidently shown on resume
- Project demonstrates relevant skills
- Project solves a real problem or demonstrates capability
- Code quality reflects professional standards
- Documentation is professional and complete
Final Review
- All checklist items are completed
- Project is ready for portfolio/resume presentation
- You feel confident showcasing this project
- Optional: Request feedback from community or programme leadership
This checklist is comprehensive. Work through it systematically to ensure your project is polished and professional.