Files
claude-hud/CONTRIBUTING.md

47 lines
1.1 KiB
Markdown
Raw Normal View History

2026-01-03 19:07:42 +11:00
# Contributing
Thanks for contributing to Claude HUD. This repo is small and fast-moving, so we optimize for clarity and quick review.
## How to Contribute
1) Fork and clone the repo
2) Create a branch
3) Make your changes
4) Run tests and update docs if needed
5) Open a pull request
## Development
```bash
npm ci
npm run build
npm test
```
## Tests
See `TESTING.md` for the full testing strategy, fixtures, and snapshot updates.
## Code Style
- Keep changes focused and small.
- Prefer tests for behavior changes.
- Avoid introducing dependencies unless necessary.
## Build Process
**Important**: PRs should only modify files in `src/` — do not include changes to `dist/`.
CI automatically builds and commits `dist/` after your PR is merged. This keeps PRs focused on source code and makes review easier.
```
Your PR: src/ changes only → Merge → CI builds dist/ → Committed automatically
```
2026-01-03 19:07:42 +11:00
## Pull Requests
- Describe the problem and the fix.
- Include tests or explain why they are not needed.
- Link issues when relevant.
- Only modify `src/` files — CI handles `dist/` automatically.