FOSS-Cell-GECPKD/chat-app

Best practices TODO

Opened this issue · 2 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

@sankarvinayak and @VipinVIP, great work and thanks for contributing! You're just left with a few items in your TODO! Also, do you wish to rename your project and repo?

It would be very nice if the project could be deployed. Can you put your issues in a comment down below in case you aren't able to deploy?

Also, there's a small typo in your readme. Please replace 'Discussions about chat-app is placed on our Gitter Chat Anybody is welcome to join these conversations.' with: 'Discussions about chat-app take place on our Gitter Chat. Anyone is welcome to join the conversations.'

VipinVIP commented

@anandbaburajan Thank you for reviewing : .. We will look into the Typo as well as remaining TO-Do's and complete it as soon as possible. 🙌🏽