Best practices TODO
Opened this issue · 3 comments
anandbaburajan commented
Code
- Proper readable and maintable code with consistent spacing and indentation
- Functions follow the "Do One Thing" rule (single-responsibility)
- Followed DRY (Don’t Repeat Yourself)
- Added comments wherever required
- Proper naming conventions
- Avoided deep nesting
Readme
- Badges (similar to the Gitter badge. You can maybe use: https://shields.io/)
- Description (why this project exists)
- Features (working of the project)
- Setup (Quick start instructions with how to download and use your project)
- Contributing (How can others contribute?)
- License ("This project is licensed under the ")
Tests and CI/CD
- Wrote tests
- Deployed the project (if possible)
- Added CI/CD tools to your project (maybe CircleCI or TravisCI) (if possible)
anandbaburajan commented
@alwin48 & @aryanbaburajan, great work so far! Thanks for contributing! There's an open PR and the project looks like it needs some more improvements. Feel free to let me know if you've any doubts and when I should review again! :D
anandbaburajan commented
Also, there's a small typo in your readme. Please replace 'Discussions about LifeTree is placed on our Gitter Chat Anybody is welcome to join these conversations.' with:
'Discussions about LifeTree take place on our Gitter Chat. Anyone is welcome to join the conversations.'
anandbaburajan commented
Also, you can add a section in the readme for 'potential improvements'.