Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

72 lines (51 loc) · 2.85 KB
Raw

How to Contribute

isbnlib has a very small code base, so it is a good project to begin your adventure in open-source.

NOTE: By contributing you agree with the license terms (LGPL v3) of the project.

Main Steps

  1. Make sure you have a GitHub account
  2. Submit a ticket for your issue or idea (ONE ticket for each issue or idea) (help), on https://github.com/xlcnd/isbnlib/issues, (if possible wait for some feedback before any serious commitment... :)
  3. Fork the repository on GitHub and clone it locally (help).
  4. pip install -r requirements-dev.txt (at your local directory).
  5. Do your code... (remember the code must run on python 3.6+ and be OS independent, you will find Github Actions very handy for testing with this requirement!)
  6. Write tests for your code using pytest and put then in the directory isbnlib/test
  7. Pass all tests and with coverage > 90%. Check the coverage locally with the command pytest -v --cov-config=setup.cfg isbnlib/test.
  8. Check if all requirements are fulfilled!
  9. Push your local changes to GitHub and make there a pull request (help) using dev as base branch (by the way, we follow the fork & pull model with this small change). VERY IMPORTANT: Don't put in the same pull request unrelated changes in the code, make one pull request for each set of related changes!

Style

Your code must be PEP8 compliant and be concise as possible (use yapf then check it with flake8 and pylint).

Use doc strings (PEP257) for users and comments (few) as signposts for fellow developers. Make your code as clear as possible.

Red Lines

Don't submit pull requests that are only comments to the code that is already in the repo! Don't expect kindness if you do that :) You can comment and give suggestions on the code at the issues page or use the link Give feedback at the bottom of each Github page.

No doc tests! Remember point 6 above.

Don't submit pull requests without checking points 8 and 9!

Suggestions

Goto issues/enhancement for possible enhancements to the code. If you have some idea that is not there enter your own. Select some focused issue and enter some comments on how you plan to tackle it.

Important

If you don't have experience with these issues, don't be put off by these requirements, see them as a learning opportunity. Thanks!