Contributing to ocrpy#
All you need to know to contribute to ocrpy, effectively.
This project uses the following integrations to ensure proper codebase maintenance:
Feature requests & bug report#
Whether you encountered a problem, or you have a feature suggestion, your input has value and can be used by contributors to reference it in their developments. For this purpose, we advise you to use Github issues.Please submit them at Github Issues
First, check whether the topic wasn’t already covered in an open / closed issue. If not, feel free to open a new one! When doing so, use issue templates whenever possible and provide enough information for other contributors to jump in.
If you are wondering how to do something with ocrpy, or a more general question, you should consider checking out Github discussions at Github Discussions
Developer mode installation#
Install all additional dependencies with the following command:
pip install -e .[dev]
In order to run the same unit tests as the CI workflows, you can run unittests locally:
To run all quality checks together
To ensure that your incoming PR complies with the lint settings, you need to install black and run the following command from the repository’s root folder:
In order to ensure there is a common import order convention, run isort as follows:
This will reorder the imports of your local files.
Additionally, to catch type-related issues and have a cleaner codebase, annotation typing are expected. After installing mypy, you can run the verifications as follows:
mypy --config-file mypy.ini ocrpy/
The mypy.ini file will be read to check your typing.
Please follow Google style for docstrings which can be found over here: Google-style
Modifying the documentation#
In order to check locally your modifications to the documentation:
cd docs make clean html
``` You can now open your local version of the documentation located at docs/_build/index.html in your browser.
Should you wish to connect somewhere else than on GitHub, feel free to reach out to us at email@example.com