Contributing

Contributions are welcome. To propose a change:

Fork and branch. Fork the repository, then create a branch off master using kebab-case (e.g. issues/12-short-description).
Edit in src/. Make changes to the scripts in src/scripts/, not in any deploy/ copy. Shared logic belongs in src/lib/common.sh — each script sources it via source "$SCRIPT_DIR/../lib/common.sh", so reuse helpers there instead of duplicating code.
Match conventions. Follow the existing style: -x/--xxxx flag pairs, a -h/--help handler, and configuration read from a project-root .env (see .env.example). Never commit a real .env. Functions are PascalCase; the entry point is Main, wrapped by RunScript.
Regenerate the flags/usage reference. The flags/usage reference (each script as a collapsible <details> block: title and source path in the <summary>, sanitized -h body inside) is generated — by gen-docs.sh — into the marked region of README.md and into docs/_includes/command-reference.md (rendered by the Command Reference page). The README per-script collapsible entries are generated; there is no hand-maintained <details> prose in the README. Everything else is hand-maintained: the per-script Parameters tables and the CLAUDE.md notes. If you change a script’s flags or usage, edit its Help()/GetArguments, then run bash src/scripts/gen-docs.sh and commit the regenerated region and include. bash src/scripts/gen-docs.sh --check reports drift; it is a hard gate in CI and an advisory (non-blocking) step in the pre-commit hook.
Test before submitting. Run the affected script(s) with bash [script-name].sh -h and through a normal run to confirm behaviour on a Unix-like system. Then run the three checks CI enforces, all of which are hard gates:
```
bash tests/run.sh
bash src/scripts/gen-docs.sh --check
shellcheck src/scripts/*.sh src/lib/common.sh install.sh uninstall.sh
```
Open a pull request. Push your branch and open a PR against master with a clear description of what changed and why. Open an issue first for larger changes.

License

This project is licensed under the MIT License. See the LICENSE.md file for details.