Contributing#

We welcome contributions! If you have any questions, open an issue or get in touch directly with the pulpo developers

Contributing to the code, examples or documentation#

If you want to contribute to the development our code with a new feature, want to share your pulpo-example or add to the documentation, please follow the GitHub contribution workflow (fork, branch, PR) to share your work.

To run the tests, install pulpo in editable mode with the test extra and run pytest from the repository root:

pip install -e ".[bw25,test]"
python -m pytest tests

The test README explains how to test both Brightway versions.

Report bugs or errors#

Something is not working as expected? You have two options:

πŸ₯ˆ Report an error#

Please open a new issue in the pulpo repository, describing the error and where you found it. A member of the pulpo developer community will then take care of the issue, but it may take some time for your issue to be resolved.

πŸ₯‡ Fix an error yourself#

If you have a solution to the error, you can create a fork of the pulpo repository, make your changes and create a pull request. The developers will assess the changes and be eternally grateful!