Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (28 loc) · 1005 Bytes

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 1005 Bytes

Contributing

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

Getting started

We assume that you have uv installed. Now fork the library on GitHub. Then clone and install the library:

git clone https://github.com/your-username-here/diffrax.git
cd diffrax
uv run prek install  # Creates a local venv + installs dependencies + installs pre-commit hooks.

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:

uv run pytest

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

uv run mkdocs serve

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