HireLens

Project

Contributing

Contributions are welcome — code, docs, rubrics, and bug reports alike. The workflow is GitHub Flow, enforced by CI and git hooks.

The workflow

  1. Branch off main: feat/<slug>, fix/<slug>, docs/<slug>… Never commit directly to main — not even for a typo.
  2. Commit with Conventional Commits — feat:, fix:, chore:, docs:… commitlint enforces this at commit time.
  3. Push early, open a draft PR, let CI run against real work.
  4. All checks green: lint (Biome), typecheck, tests, build. A red check never merges.
  5. Self-review your diff in the GitHub UI before requesting review — hunt for leftover console.log, secrets, dead code, unlinked TODOs.
  6. Squash-merge; the commit message becomes the changelog entry. Delete the branch.

Definition of Done

  • Unit tests for new core logic; Zod validation at every new trust boundary.
  • Loading, empty, and error states designed — not just the happy path.
  • Keyboard accessible; respects prefers-reduced-motion; works in dark and light.
  • Docs updated if behavior changed. No any without justification.

Good first contributions

  • Rubrics. Curated rubric JSON for new roles is a huge lever — see the rubric schema in packages/core.
  • Troubleshooting entries. Hit an error not on the troubleshooting page? Document it.
  • Eval cases. The benchmark grows more meaningful with every realistic synthetic resume added.
  • Docs. If a quickstart step confused you, the next person too — PR the fix.

Before you start

Dev setup lives in the quickstart. Read the full CONTRIBUTING.md and the Code of Conduct — both are short, and both are enforced.