Contributing to the project

Love the project? We’d love your help! Whether you’re fixing a bug, improving documentation, or suggesting a new feature, your contribution is welcome.

How to get started

  1. Search first: Before opening a new issue, please browse the open issues to see if it has already been discussed.

  2. Follow the guides: If you are new to open source, check out the Open Source Guides for best practices.

Your first Pull Request?

No worries! You can learn the ropes with this step-by-step guide.

Linting

To maintain a high standard of code quality, we use automated tools to check for errors and formatting.

  • ShellCheck: Validates shell scripts for common errors and pitfalls.

  • REUSE: Checks that all files have proper license and copyright headers.

These checks run automatically on every pull request via CI.

To run ShellCheck locally on a single script:

shellcheck <path/to/script.sh>

To run ShellCheck on all shell scripts in the project at once:

find . -path '*/.*' -prune -o -name '*.sh' -exec shellcheck '{}' +

To run REUSE locally:

pip install reuse
reuse lint

Recognition

We value every contribution. Once your PR is merged, our bot can officially recognize you in our contributors list.

Just add a comment to your PR:

@all-contributors please add @<your-username> for <contributions>

Support the project

If you find this project useful and want to support its ongoing development, please consider making a donation.

Thank you for helping us grow!