Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Best practices TODO #8

Open
12 of 15 tasks
anandbaburajan opened this issue Oct 9, 2020 · 2 comments
Open
12 of 15 tasks

Best practices TODO #8

anandbaburajan opened this issue Oct 9, 2020 · 2 comments

Comments

@anandbaburajan
Copy link
Contributor

anandbaburajan commented Oct 9, 2020

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
Copy link
Contributor Author

anandbaburajan commented Nov 21, 2020

@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
Copy link
Collaborator

@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. 🙌🏽

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants