Contributing¶

Few things to know before diving in the code.

Project Guidelines¶

Be pythonic, document and test your code. That’s all.

To tinker with the code, it’s recommended that you install the library from the cloned folder with:

pip install --editable .

This will allow you to install ValveFGD from the folder. This way, you can modify ValveFGD as you develop your own project around it.

The documentation is done with Sphinx. To build the Sphinx documentation, you need:

pip install -r docs/requirements.txt # one-time setup

sphinx-autobuild docs/source docs/build

The documentation pages will be served on http://127.0.0.1:8000 by default.

Tests can be ran from the root folder using:

pip install -r requirements.txt # one-time setup

pytest