mirror of
https://github.com/jarrodwatts/claude-hud.git
synced 2026-05-21 15:52:37 +00:00
36 lines
712 B
Markdown
36 lines
712 B
Markdown
|
# 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.
|
||
|
|
|
||
|
|
## Pull Requests
|
||
|
|
|
||
|
|
- Describe the problem and the fix.
|
||
|
|
- Include tests or explain why they are not needed.
|
||
|
|
- Link issues when relevant.
|