CONTRIBUTING.md

Contributing

Contributions (pull requests) are very welcome! Here's how to get started.

---

Getting started

First fork the library on GitHub.

Then clone and install the library:

git clone https://github.com/your-username-here/diffrax.git
cd diffrax
pip install -e '.[dev]'
pre-commit install  # `pre-commit` is installed by `pip` on the previous line

---

If you're making changes to the code:

Now make your changes. Make sure to include additional tests if necessary.

Next verify the tests all pass:

pip install -e '.[tests]'
pytest  # `pytest` is installed by `pip` on the previous line.

Then push your changes back to your fork of the repository:

git push

Finally, open a pull request on GitHub!

---

If you're making changes to the documentation:

Make your changes. You can then build the documentation by doing

pip install -e '.[docs]'
mkdocs serve

You can then see your local copy of the documentation by navigating to localhost:8000 in a web browser.