Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (22 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

35 lines (22 loc) · 1.65 KB
Raw

Contributing to JobRouteAI

Thanks for considering a contribution. JobRouteAI is intentionally small at the core: readable agent specifications, portable client wrappers, file-based state, and optional integrations.

Workflow

  1. Fork the repository.
  2. Create a branch from main using a descriptive name such as feat/ashby-guidance or fix/windows-installer.
  3. Make focused changes.
  4. Run python scripts/validate_repo.py when Python 3.11+ is available.
  5. Update documentation/tests when behavior changes.
  6. Open a pull request against main and explain the problem, approach, and testing performed.

Do not commit directly to main. The repository is intended to protect main so contributor changes arrive through PRs and are merged by the repository owner.

Agent changes

Canonical behavior lives under agents/. If you change an agent's contract:

  • update the canonical file first;
  • keep .github/agents/, .claude/agents/, and .codex/agents/ wrappers compatible;
  • preserve the handoff contract;
  • preserve no-fabrication and automated-mode rules.

Privacy

Never include a real resume, candidate profile, application answer, API key, token, cookie, or browser session in a PR, issue, fixture, or screenshot. Use fictional data only.

Integration contributions

Prefer official APIs, public documented endpoints, reviewed MCPs, or bring-your-own connector support. Core will not accept unauthorized scraping designed to bypass a site's access controls or terms.

Pull request quality

A useful PR is small enough to review, has a clear reason, and includes evidence that it works. Large rewrites without a migration reason are harder to merge.