559dd6f40f
- Add npm scripts: validate, validate:strict, index, readme, chain, catalog, build - Align docs to V4 and 560 skills (GETTING_STARTED, FAQ, BUNDLES, MAINTENANCE, vietnamese) - build-catalog: output to data/ for catalog, bundles, aliases; add to CI and drift check - Add yaml dep, Node setup and catalog step in CI; extend auto-commit and drift msg - Translate CI and MAINTENANCE to English; update CI_DRIFT_FIX and maintenance routine - QUALITY_BAR/CONTRIBUTING: canonical validator npm run validate; legacy note in validate-skills.js
66 lines
2.2 KiB
Markdown
66 lines
2.2 KiB
Markdown
# 🏆 Quality Bar & Validation Standards
|
|
|
|
To transform **Antigravity Awesome Skills** from a collection of scripts into a trusted platform, every skill must meet a specific standard of quality and safety.
|
|
|
|
## The "Validated" Badge ✅
|
|
|
|
A skill earns the "Validated" badge only if it passes these **5 automated checks**:
|
|
|
|
### 1. Metadata Integrity
|
|
|
|
The `SKILL.md` frontmatter must be valid YAML and contain:
|
|
|
|
- `name`: Kebab-case, matches folder name.
|
|
- `description`: Under 200 chars, clear value prop.
|
|
- `risk`: One of `[none, safe, critical, offensive]`.
|
|
- `source`: URL to original source (or "self" if original).
|
|
|
|
### 2. Clear Triggers ("When to use")
|
|
|
|
The skill MUST have a section explicitly stating when to trigger it.
|
|
|
|
- **Good**: "Use when the user asks to debug a React component."
|
|
- **Bad**: "This skill helps you with code."
|
|
|
|
### 3. Safety & Risk Classification
|
|
|
|
Every skill must declare its risk level:
|
|
|
|
- 🟢 **none**: Pure text/reasoning (e.g., Brainstorming).
|
|
- 🔵 **safe**: Reads files, runs safe commands (e.g., Linter).
|
|
- 🟠 **critical**: Modifies state, deletes files, pushes to prod (e.g., Git Push).
|
|
- 🔴 **offensive**: Pentesting/Red Team tools. **MUST** have "Authorized Use Only" warning.
|
|
|
|
### 4. Copy-Pasteable Examples
|
|
|
|
At least one code block or interaction example that a user (or agent) can immediately use.
|
|
|
|
### 5. Explicit Limitations
|
|
|
|
A list of known edge cases or things the skill _cannot_ do.
|
|
|
|
- _Example_: "Does not work on Windows without WSL."
|
|
|
|
---
|
|
|
|
## Support Levels
|
|
|
|
We also categorize skills by who maintains them:
|
|
|
|
| Level | Badge | Meaning |
|
|
| :------------ | :---- | :-------------------------------------------------- |
|
|
| **Official** | 🟣 | Maintained by the core team. High reliability. |
|
|
| **Community** | ⚪ | Contributed by the ecosystem. Best effort support. |
|
|
| **Verified** | ✨ | Community skill that has passed deep manual review. |
|
|
|
|
---
|
|
|
|
## How to Validate Your Skill
|
|
|
|
The canonical validator is `scripts/validate_skills.py`. Run `npm run validate` (or `npm run validate:strict`) before submitting a PR:
|
|
|
|
```bash
|
|
npm run validate # soft mode (warnings only)
|
|
npm run validate:strict # strict mode (CI uses this)
|
|
```
|