CONTRIBUTING.md

Contributing Instructions

1. General guideline

In general, contributors should make code changes on a branch, and then create a pull request to have the changes merged.

2. Install the library for development

• It is strongly recommended that contributors work on code changes in an isolated Python environment
• Use pip install -e . to install this library locally, so that any local code changes are reflected immediately in your current Python environment

3. Running local tests and linting

You can run tests with the tox command.

And you can run auto-formatting with the command pre-commit run -a.

4. Update the documentations

If you would like to make changes to the documentations of this library, you need to install the dependencies for building documentations with the following command (from the root directory):

pip install -r docs/requirements.txt

To build the documentation HTML pages locally, navigate to the docs folder, and run make clean html. To view the generated HTML documentation, open the file docs/build/html/index.html in the browser.