We welcome contributions! Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Requirements

Linting

Linting can be run via pre-commit. Run for all files in the repo:

pre-commit run -a

For the best development experience, set up linting and autofixing pre-commit git hooks using the pre-commit tool.

After installing pre-commit, run

pre-commit install

in the repo to configure hooks.

NOTE: If necessary, you can always skip hooks with git commit --no-verify

All contributions must and will be licensed under MIT.