Contributing to Prompt Chime

March 21, 2026 · View on GitHub

Thanks for your interest in contributing!

How to Contribute

  1. Fork the repository
  2. Create a branch for your feature or fix
  3. Make your changes — keep commits small and focused
  4. Run the tests: bash scripts/test_e2e.sh
  5. Submit a pull request with a clear description

Guidelines

  • All shell scripts must pass with set -euo pipefail
  • Validate all user input before use (no raw interpolation into commands)
  • Sound names must match ^[a-zA-Z0-9_-]+$
  • Config writes must be atomic (write to .tmp, then os.replace)
  • Test on your OS before submitting — the test suite adapts to the current platform

Reporting Issues

Open a GitHub issue with:

  • Your OS and shell version
  • Steps to reproduce
  • Expected vs actual behavior

Security

If you find a security vulnerability, please open a GitHub issue or contact the maintainer directly.