Contributing¶
Everyone is welcomed to contribute!
Beginners see this tutorial; documentation is a great place to start.
Documentation¶
Great documentation is absolutely key in any a project. Please feel free to contribute edits and additions to it, especially if you’re new! It is written in reStructuredText for Sphinx, and you can read a primer here.
Code¶
Inline code docstrings (sorely needed!), additional test coverage (also needed!), bug fixes, extension of existing functionality, new functionalities, and more are always welcomed.
Tip: you can ensure that your contribution will pass all tests by running tests locally (after installing all Python dev packages):
pip install -U webchanges[testing]
# linux:
coverage run --source=webchanges -m pytest -v
# Windows:
coverage.bat
All tests need to pass, and the amount of lines covered by tests should not decrease.