How to Contribute

isbnlib-bnf 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

Make sure you have a GitHub account
Submit a ticket for your issue or idea (help), on https://github.com/xlcnd/isbnlib_bnf/issues, (if possible wait for some feedback before any serious commitment... :)
Fork the repository on GitHub and clone it locally (help).
pip install -r requirements-dev.txt (at your local directory).
Do your code... (remember the code must run on python 2.7, 3.5+, and be OS independent It is easier if you start to write in python 3 and then adapt for python 2) (you will find Github Actions very handy for testing with this requirement!)
Write tests for your code using pytest and put then in the directory isbnlib_bnf/test
Pass all tests and with coverage > 90%. Check the coverage locally with the command (linux and macos) pytest -q --cov=isbnlib_bnf --cov-fail-under=90 isbnlib_bnf/test/test*.py.
Check if all requirements are fulfilled!
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).

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.

Don't submit pull requests that are only comments to the code that is already in the repo!

No doc tests! Remember point 6 above.

Don't submit pull requests without checking point 8!

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