Contributing to docTR#
Everything you need to know to contribute efficiently to the project.
This project uses the following integrations to ensure proper codebase maintenance:
Github Worklow - run jobs for package build and coverage
Codecov - reports back coverage results
As a contributor, you will only have to ensure coverage of your code by adding appropriate unit testing of your code.
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.
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 docTR, or a more general question, you should consider checking out Github discussions. See it as a Q&A forum, or the docTR-specific StackOverflow!
Developer mode installation#
Install all additional dependencies with the following command:
pip install -e .[dev]
Code: ensure to provide docstrings to your Python code. In doing so, please follow Google-style so it can ease the process of documentation later.
Commit message: please follow Udacity guide
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 flake8 and run the following command from the repository’s root folder:
This will read the
.flake8 setting file and let you know whether your commits need some adjustments.
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 doctr/
mypy.ini file will be read to check your typing.
To keep a sane docstring structure, if you install pydocstyle, you can verify your docstrings as follows:
.pydocstyle file will be read to configure this operation.
Modifying the documentation#
In order to check locally your modifications to the documentation:
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 join us on Slack, where you will find a