Files
claude-hud/CONTRIBUTING.md
Jarrod Watts de083ae9c6 security: add CI workflow to build dist/ after merge (#12)
* security: add CI workflow to build dist/ after merge

Phase 1 of removing dist/ from PRs to close security attack vector.

Changes:
- Add build-dist.yml workflow that builds and commits dist/ on push to main
- Update CONTRIBUTING.md with build process documentation
- Reset CHANGELOG.md to 0.0.1 (initial release)

After this is verified working, Phase 2 will remove dist/ from git tracking.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: prevent CI re-trigger on dist/ changes

Add paths-ignore for dist/** to ci.yml so CI doesn't re-run when
build-dist workflow commits compiled output. Addresses race condition.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: add concurrency, permissions, and build verification

Address review feedback:
- Add concurrency group to queue builds (prevents race conditions)
- Add explicit contents: write permission
- Add build verification step (test -f dist/index.js)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: run tests before building dist/

---------

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-04 22:41:00 +11:00

1.1 KiB

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

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

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.