Skip to content

Commit 1d125a9

Browse files
authored
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
1 parent 5ae79b9 commit 1d125a9

2 files changed

Lines changed: 27 additions & 3 deletions

File tree

.claude/CLAUDE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,13 @@ npm run validate # Fix all errors before committing. Warnings are acceptable
3939
```
4040
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.
4141

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+
4249
## LLM Quality Scoring
4350

4451
Before submitting a PR, run LLM scoring locally to check skill quality:

CONTRIBUTING.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ if the user is already authenticated. Keep it minimal — no backend code,
168168
no icp.yaml, no deploy steps."
169169
```
170170

171-
**Running evaluations** (optional, requires `claude` CLI):
171+
**Running evaluations** (requires `claude` CLI):
172172

173173
```bash
174174
node scripts/evaluate-skills.js <skill-name> # All evals, with + without skill
@@ -181,7 +181,7 @@ node scripts/evaluate-skills.js <skill-name> --triggers-only # Trigger evals
181181

182182
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).
183183

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.
185185

186186
### 6. That's it — the website auto-discovers skills
187187

@@ -195,6 +195,20 @@ Stats (skill count, categories) all update automatically.
195195
- Include a brief description of what the skill covers and why it's needed
196196
- Include LLM scoring output in your PR description if you ran it locally (see step 4)
197197
- 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+
198212
- **All PRs require approval from a repo admin before merge.** No skill additions or updates go live without review.
199213

200214
---
@@ -204,7 +218,10 @@ Stats (skill count, categories) all update automatically.
204218
1. Edit the `SKILL.md` content
205219
2. Run `npm run validate`
206220
3. Optionally run LLM scoring (see step 4 above)
207-
4. Submit a PR with a summary of what changed
221+
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).
208225

209226
The website auto-generates from SKILL.md frontmatter — no need to edit any source files.
210227

0 commit comments

Comments
 (0)