Commit Graph
4 Commits
Author SHA1 Message Date
ayobamiseun 0e35f3e0ff docs(onboarding): correct the verification loop per review
- Node 24, the version CI pins, not Node 20+.
- Drop "in the order the workflow runs it": the checks are spread across
  jobs and run in a different order. Group them by what they cover.
- Drop "this is the full set": name the two jobs that need the Claude
  Code CLI (claude plugin validate, and the marketplace install) and say
  when to run them.
- Restore the rule that editing skills/using-agent-skills/SKILL.md
  requires the session-start hook test, since the script embeds the file.
- List the three hook test commands; `bash hooks/*-test.sh` runs only the
  first match and passes the others as arguments.
- Remove the "new validator ships with a test file and a CI step" line;
  it is policy, not a doc sync, and goes in its own PR.
2026-10-10 14:00:40 +01:00
ayobamiseun b7c1cb18e4 docs: make the documented verification loop match what CI runs
docs/developer-onboarding.md promises that everything CI runs can be run
locally, then lists three validators, the eval runner and one hook test.
CI runs six validators, seven unit-test files and three hook suites on
three operating systems, so a contributor following the doc can fail
several steps they never ran. The Tier 1 row in evals/README.md names
two validators where there are five, and Tier 2 omits the rank-1 floor.

List every workflow command in the onboarding block in workflow order,
note the PowerShell glob caveat, state the cross-platform leg, name the
workflow file as the source of truth, and align Path 3 and the pre-PR
checklist. Update both tier rows in evals/README.md. CLAUDE.md's stale
line is left for later because #548 edits that file.

Every command in the new block was run from this branch and passes, and
every command in the workflow appears in the block.
2026-10-10 13:59:34 +01:00
Joan Leon 7209bd12d8 docs(developer-onboarding): point to CONTRIBUTING for new-skill rules
Per review: the new-skill 'ships as a set' block restated CONTRIBUTING's
frontmatter, anatomy, and eval-count rules instead of pointing at them,
which is the 'don't duplicate, reference' rule this guide champions. Keep
the shape (SKILL.md + eval case + optional scripts) and defer the exact
requirements to CONTRIBUTING.md and skill-anatomy.md so they can't drift.
2026-07-12 19:48:34 +02:00
Joan Leon 695505ddac docs: add developer onboarding guide for repo contributors
Add docs/developer-onboarding.md: a guided tour for people working on the
repo itself (the five layers, local setup, the verification loop, the
contribution paths, and a suggested reading order), complementing the
authoritative rules in CONTRIBUTING.md, skill-anatomy.md, and evals/README.md.
Link it from the top of CONTRIBUTING.md as the map to its rulebook.
2026-07-12 15:50:11 +02:00