Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 727 Bytes

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 727 Bytes

Contributing

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


First fork the library on GitHub.

Then clone and install the library in development mode:

git clone https://github.com/your-username-here/diffrax.git
cd diffrax
pip install -e .

Then install the pre-commit hook:

pip install pre-commit
pre-commit install

These hooks use Black and isort to format the code, and flake8 to lint it.

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

Next verify the tests all pass:

pip install pytest
pytest

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

git push

Finally, open a pull request on GitHub!