You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: add eval requirements to contribution and agent guidelines (#160)
- CLAUDE.md: remind agents to consider evals when modifying skills,
add PR eval requirements (new skill vs improvement, details block)
- CONTRIBUTING.md: make eval results required for new skills in PRs,
clarify that improvements only need results for new eval cases,
add <details> collapse format example
Copy file name to clipboardExpand all lines: .claude/CLAUDE.md
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,6 +39,13 @@ npm run validate # Fix all errors before committing. Warnings are acceptable
39
39
```
40
40
Validate uses [skill-validator](https://github.com/agent-ecosystem/skill-validator) for structure, links, content analysis, and contamination checks. It runs in CI and blocks deployment on errors.
41
41
42
+
When adding new behaviors, commands, or pitfalls to a skill, also consider whether the `evaluations/<skill-name>.json` file needs new eval cases to cover them. New pitfalls and non-obvious behaviors are strong candidates for evals — especially adversarial ones where an agent would likely get it wrong without the skill.
43
+
44
+
**PR eval requirements:**
45
+
-**New skill:** run the full suite (`node scripts/evaluate-skills.js <skill-name>`) and include both output eval and trigger eval results in the PR description. PRs without eval results are not accepted.
46
+
-**Skill improvement with new evals:** run only the new eval cases and include both with-skill and baseline results.
47
+
- Always wrap eval output in a collapsed `<details>` block in the PR description.
48
+
42
49
## LLM Quality Scoring
43
50
44
51
Before submitting a PR, run LLM scoring locally to check skill quality:
This sends each prompt to Claude with and without the skill, then has a judge score the output. Results are saved to `evaluations/results/` (gitignored).
183
183
184
-
Including a summary of eval results in your PR description is recommended but not required — running evals needs `claude` CLI access and costs API credits.
184
+
**Eval results are required in the PR for new skills** — see [Step 7](#7-submit-a-pr) for the required format.
185
185
186
186
### 6. That's it — the website auto-discovers skills
- Include a brief description of what the skill covers and why it's needed
196
196
- Include LLM scoring output in your PR description if you ran it locally (see step 4)
197
197
- Make sure the SKILL.md is tested — code examples should compile and deploy
198
+
-**Eval results are required.** Run the full evaluation suite locally and paste the results into the PR description. Both output evals and trigger evals must be included. PRs without eval results will not be accepted.
199
+
-**Collapse the results** using a `<details>` block to keep the PR description readable:
200
+
201
+
````markdown
202
+
<details>
203
+
<summary>Evaluation results</summary>
204
+
205
+
```
206
+
[paste eval output here]
207
+
```
208
+
209
+
</details>
210
+
````
211
+
198
212
-**All PRs require approval from a repo admin before merge.** No skill additions or updates go live without review.
4. If you added new evaluation cases, run those evals locally and include the results in the PR
222
+
5. Submit a PR with a summary of what changed
223
+
224
+
**Eval results for skill improvements:** If you added new eval cases, you only need to provide results for those new cases — not the full suite. Both the with-skill and baseline (without-skill) results must be included. Collapse them in the PR description using a `<details>` block (see [Submit a PR](#7-submit-a-pr) above).
208
225
209
226
The website auto-generates from SKILL.md frontmatter — no need to edit any source files.
0 commit comments