Contributing

User experiences, bugs, and feature requests

To report bugs and suggest features (including better documentation), please head over to issues on GitHub. If you have a question, please open a discussion on GitHub.

Code contributions

In general, we use pull requests to make changes to Jaxley. So, if you are planning to make a contribution, please fork, create a feature branch and then make a PR from your feature branch to the upstream Jaxley (details).

Development environment

Clone the repo and install via setup.py using pip install -e ".[dev, doc]" (the dev flag installs development and testing dependencies, the doc flag install documentation dependencies).

Style conventions

For docstrings and comments, we use Google Style.

Code needs to pass through the following tools, which are installed alongside Jaxley:

black: Automatic code formatting for Python. You can run black manually from the console using black . in the top directory of the repository, which will format all files.

isort: Used to consistently order imports. You can run isort manually from the console using isort in the top directory.

black and isort are checked as part of our CI actions. If these checks fail please make sure you have installed the latest versions for each of them and run them locally.

Online documentation

Most of the documentation is written in markdown (basic markdown guide) or Sphinx.

You can directly fix mistakes and suggest clearer formulations in markdown files simply by initiating a PR on through GitHub. Click on documentation file and look for the little pencil at top right.