Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,21 @@ skills/your-skill-name/
│ └── project-template.md
├── scripts/ # Optional: Executable code agents can run
│ └── validate.sh
├── evals/
│ └── evals.json # Required: Skill evaluation metrics (3-5 evals)
└── AGENTS.md # Optional: Condensed version for Cursor/Copilot
```

Evals live outside the skill directory, in `evals/<skill-name>/evals.json`:

```
evals/
└── mapbox-your-skill-name/
└── evals.json # Required: 3-5 evals per skill
```

They are kept out of `skills/` deliberately. Both plugin manifests ship everything
under `skills/`, so an `evals.json` there would hand every installed agent the
expected answers for the suite that grades these skills.

This is our convention for progressive skill disclosure — only `name` and `description` at startup, full SKILL.md on activation, and `references/`/`assets/`/`scripts/` on demand.

Skills are loaded progressively — only `name` and `description` at startup (~100 tokens), full SKILL.md on activation (< 5,000 tokens recommended), and `references/`/`assets/`/`scripts/` on demand.
Expand Down Expand Up @@ -272,7 +282,8 @@ Evals measure how much a skill actually improves AI responses by comparing answe

### Eval File Structure

Create `skills/your-skill-name/evals/evals.json`:
Create `evals/your-skill-name/evals.json` (outside `skills/`, so the expectations are
not shipped to users):

```json
{
Expand Down
Loading
Loading