CONTRIBUTING.md

Contributing

Contributions in the form of pull requests are very welcome! Here's how to get started.

Getting started

First, fork the library on GitHub. You can do this by clicking on the Fork button in the GitHub interface.

Next, clone and install the library in development mode:

git clone [email protected]:YOUR_GIT_USERNAME/jaxdf.git
cd jaxdf
pip install poetry
poetry install

After that, install the pre-commit hooks:

pip install pre-commit
pre-commit install

If you're making changes to the code

Run git checkout -b my_contribution and make your changes. Be sure to include additional tests if necessary. Increasing the coverage in the coverage report would be great! 😃

After making your changes, verify that all tests pass.

coverage run --source=jaxdf -m pytest -xvs

Once you are satisfied with your changes, add an entry to the changelog using kacl-cli, for example:

kacl-cli add fixed "Fixed the unfixable issue 🎉" --modify

For more information on the types of changes that can be added to the changelog, visit this page.

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

git push

Finally, open a pull request on GitHub! You can do this by clicking on the Pull Request button in the GitHub interface.

Wait for the CI to run, and one of the developers will review your PR.

If you're making changes to the documentation

Make your changes, and then build the documentation using:

mkdocs serve

Please note that due to the way operators are documented, this might take some time.

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