Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (56 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

72 lines (56 loc) · 2.61 KB
Raw

Contributing

Thanks for your interest in improving RecruitKit.

Getting Started

git clone https://github.com/tal7aouy/RecruitKit.git
cd RecruitKit
./install.sh

Start a new Claude Code session to pick up the installed skills.

Project Layout

Path What lives there
recruit/SKILL.md Main orchestrator — routes every /recruit command
skills/<name>/SKILL.md One sub-skill per command
agents/<name>.md Subagents launched in parallel by /recruit analyze
scripts/*.py Python helpers invoked by skills
banner.svg README banner

Adding a New Skill

  1. Create skills/recruit-<name>/SKILL.md.
  2. Add the command to the routing table in recruit/SKILL.md.
  3. Add the skill name to the SKILLS array in both install.sh and uninstall.sh.
  4. Add a row to the command tables in README.md and the installer's summary output.
  5. Reinstall and verify the command works end to end in a fresh session.

Skipping step 3 is the most common mistake — the skill will work locally but never install for anyone else.

Adding a New Agent

  1. Create agents/recruit-<name>.md describing the agent's role, input, analysis process, scoring, and output format.
  2. Add the agent name to the AGENTS array in both install.sh and uninstall.sh.
  3. Wire the agent into the parallel-launch block in skills/recruit-analyze/SKILL.md and update the weight table if the composite score now has a different denominator.

Conventions

  • Skills are written as instructions to Claude, in second person ("You analyze…"), not as documentation about Claude.
  • Output files are uppercase-kebab Markdown at the repo root (RECRUIT-ANALYSIS-*.md), one per command.
  • Scoring stays on the 0–100 scale with the weights defined in recruit/SKILL.md. If you change a weight, change it everywhere it is documented (orchestrator, analyze skill, README, agent file).
  • Shell scripts target Bash 3.2 (macOS default) and run under set -euo pipefail.
  • Python scripts target 3.8+, standard library only unless the dependency is added to requirements.txt and treated as optional.
  • Employment law: every skill and agent must carry the EEOC / educational disclaimer. Recruiting is regulated — never remove the disclaimers.

Before You Open a PR

bash -n install.sh && bash -n uninstall.sh     # shell syntax
python3 -m compileall -q scripts/              # python syntax
shellcheck install.sh uninstall.sh             # if available

Then open a PR against main describing what changed and how you verified it.