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.

Sign up for GitHub

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

Jump to bottom

Best practices TODO #11

Open
17 tasks
anandbaburajan opened this issue Oct 9, 2020 · 0 comments
Open
17 tasks

Best practices TODO #11

anandbaburajan opened this issue Oct 9, 2020 · 0 comments

Comments

@anandbaburajan
Copy link
Contributor

Code

  • Proper readable and maintable code with consistent spacing and indentation
  • Functions follow the "Do One Thing" rule (single-responsibility)
  • Followed the SOLID principles (OOP)
  • 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?)
  • Thanks to (List of contributors)
  • 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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@anandbaburajan