# Contributing

Thanks for helping improve Pi Rich Questions.

## Before opening work

- Search [existing issues](https://github.com/ArtOfIntel/pi-rich-questions/issues).
- Use a public issue for reproducible bugs and scoped feature proposals.
- Use the private process in [SECURITY.md](SECURITY.md) for vulnerabilities.
- Keep changes focused; discuss public schema, result-contract, or interface changes before implementing them.

## Development workflow

```bash
npm install
npm run check
```

Add focused tests for behavior changes and manually smoke-test affected TUI paths. For documentation or packaging changes, also check internal Markdown links, run `npm pack --dry-run --json`, and run `git diff --check`.

Update relevant documentation and add user-visible changes under `[Unreleased]` in [CHANGELOG.md](CHANGELOG.md). Follow the existing TypeScript style and avoid drive-by refactors.

## Pull requests

Explain the problem, the chosen approach, validation performed, and any terminal/provider-specific limitations. Keep commits reviewable and do not include generated coverage, package archives, credentials, local Pi settings, or machine-specific paths.

By contributing, you agree that your contribution is licensed under the project's [MIT License](LICENSE).