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 #4

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

Best practices TODO #4

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

  • Wrote tests
@anandbaburajan
Copy link
Contributor Author

anandbaburajan commented Nov 21, 2020

@sankarvinayak and @MUHAMMEDRIZALKE, great work and thanks for contributing! You're just left with one item in your TODO! Also, do you wish to rename your project and repo? Also, can you update the instructions in you readme? Running python peer.py doesn't seem to be working.

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

Also, it would be really great if your functions had a docstring.

@anandbaburajan
Copy link
Contributor Author

I'm trying to run your project but python peer.py command isn't working. Can you please look into it? Thanks!

anandbaburajan pushed a commit that referenced this issue Dec 26, 2020
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

1 participant