CONTRIBUTING.md

How to Contribute

Always happy to get issues identified and pull requests!

General considerations

1. Keep it small. The smaller the change, the more likely we are to accept.
2. Changes that fix a current issue get priority for review.
3. Check out GitHub guide if you've never created a pull request before.

Getting started

1. Fork the repo
2. Clone your fork
3. Create a branch for your changes

This last step is very important, don't start developing from master, it'll cause pain if you need to send another change later.

TIP: If you're working on a GitHub issue, name your branch after the issue number, e.g. issue-123-<ISSUE-NAME>. This will help us keep track of what you're working on. If there is not an issue for what you're working on, create one first please. Someone else might be working on the same thing, or we might have a reason for not wanting to do it.

Pre-commit

GitHub Actions is going to run Pre-commit hooks on your PR. If the hooks fail, you will need to fix them before your PR can be merged. It will save you a lot of time if you run the hooks locally before you push your changes. To do that, you need to install pre-commit on your local machine.

pip install pre-commit

Once installed, you need to add the pre-commit hooks to your local repo.

pre-commit install

Now, every time you commit, the hooks will run and check your code. If they fail, you will need to fix them before you can commit.

If it happened that you committed changes already without having pre-commit hooks and do not want to reset and recommit again, you can run the following command to run the hooks on your local repo.

pre-commit run --all-files

Help Us Improve This Documentation

If you find that something is missing or have suggestions for improvements, please submit a PR.