CONTRIBUTING.rst 1.0 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. How To Contribute
  2. =================
  3. First off, thank you for considering contributing to ``bandcamp-dl``!
  4. It's people like *you* who make it is such a great tool for everyone.
  5. Here are a few guidelines to get you started (but don't be afraid to
  6. open half-finished PRs and ask questions if something is unclear!):
  7. Workflow
  8. --------
  9. - No contribution is too small!
  10. Please submit as many fixes for typos and grammar bloopers as you can!
  11. - Try to limit each pull request to *one* change only.
  12. - Once you've addressed review feedback, make sure to bump the pull
  13. request with a short note.
  14. Code
  15. ----
  16. - Try to adhere to PEP8 as best you can.
  17. - allowed line code length for this project is up to 99 chars
  18. - documentation line length is up to 72 chars
  19. - Annotate functions
  20. - Specify return types
  21. - Add docstrings
  22. *****
  23. Again, this list is mainly to help you to get started by codifying
  24. tribal knowledge and expectations. If something is unclear, feel free
  25. to ask for help!
  26. Thank you for considering contributing to ``bandcamp-dl``!