Chapter 6 Project Checklist

In the same spirit as the coding principles, the checklist below has been designed to help you achieve ‘best practice’ in your project. Please note that the features listed below are recommendations and are not compulsory.

• Project follows the Github workflow
• Project repo has a description and is tagged with topics
• Project repo contains a populated README
• Project dependencies are managed
• Sensible defaults have been used within the code
• A linter has been applied to the code
• Functions are documented
• Project contains unit tests
• Tests and linters run automatically on pull requests
• All code has been reviewed by another person