Contribute¶

We are happy to receive contributions to emiproc.

If you have questions or need help, you are welcome to open an issue on github.

We are happy to answer your questions and help you to get started.

Contribute as a developper¶

If you want to contribute to the code, the prefered way is via pull requests on github.

You can follow the tutorials below to understand how emiproc works and how to expand it.

To install emiproc for developpement, we recomment that you run

pip install -e .[dev]

You can then run the tests with the command, which you should run in the main directory of the repository (where the pyproject.toml file is located):

pytest

Also, emiproc uses black for code formatting. You can run it with the command:

black .

For bulding the documentation, you can run:

cd docs
make html

or on Windows:

cd docs
.\make.bat html