Best practices TODO

[anandbaburajan]

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]

@anasvakyathodi, great work, thanks for contributing and helping others get started with open source! You're just left with a few items in your TODO! For the readme, I'd suggest to refer the readme here. Also, the Todo section in your readme can be made a bit more prominent.

[anasvakyathodi]

@anasvakyathodi, great work, thanks for contributing and helping others get started with open source! You're just left with a few items in your TODO! For the readme, I'd suggest to refer the readme here. Also, the Todo section in your readme can be made a bit more prominent.

Sure @anandbaburajan ... Thanks for your help :)

[anandbaburajan]

Also it would be better if console.log() statements were replaced with logging and you can put a .env.example too. You can use https://swagger.io/ for the API docs too.

[anasvakyathodi]

Okay Thanks @anandbaburajan