|
| 1 | +--- |
| 2 | +name: compliance-checker |
| 3 | +description: | |
| 4 | + Run skill design compliance validation for agentic collections. Use when the user asks to: |
| 5 | + - "Check skill compliance" / "Validate skill design" / "Run compliance check" |
| 6 | + - "Verify my skills follow design principles" |
| 7 | + - Before committing skill changes |
| 8 | +
|
| 9 | + Runs the validate_skill_design.py script against SKILL_DESIGN_PRINCIPLES.md. |
| 10 | +--- |
| 11 | + |
| 12 | +# Skill Design Compliance Checker |
| 13 | + |
| 14 | +Run the programmatic compliance check for skills in this agentic-collections repository. |
| 15 | + |
| 16 | +## When to Use This Skill |
| 17 | + |
| 18 | +Invoke this skill when the user wants to: |
| 19 | +- Validate skills against [SKILL_DESIGN_PRINCIPLES.md](SKILL_DESIGN_PRINCIPLES.md) |
| 20 | +- Check compliance before committing or opening a PR |
| 21 | +- Verify design principle adherence (DP1–DP7) |
| 22 | + |
| 23 | +## Workflow |
| 24 | + |
| 25 | +1. **Run from project root** (the workspace root). |
| 26 | + |
| 27 | +2. **Preferred: validate only changed skills** (recommended for local dev): |
| 28 | + ```bash |
| 29 | + make validate-skill-design-changed |
| 30 | + ``` |
| 31 | + This validates only staged and unstaged skill changes. |
| 32 | + |
| 33 | +3. **Alternative: validate all skills or a specific pack**: |
| 34 | + ```bash |
| 35 | + make validate-skill-design |
| 36 | + # Or validate a specific pack: |
| 37 | + make validate-skill-design PACK=rh-sre |
| 38 | + ``` |
| 39 | + |
| 40 | +4. **Report results** to the user: |
| 41 | + - If validation passes: report success |
| 42 | + - If validation fails: list the errors and suggest fixes per the design principles |
| 43 | + |
| 44 | +## Dependencies |
| 45 | + |
| 46 | +- `uv` must be installed (run `make install` if needed) |
| 47 | +- Script: `scripts/validate_skill_design.py` |
| 48 | +- Reference: [SKILL_DESIGN_PRINCIPLES.md](../../../SKILL_DESIGN_PRINCIPLES.md) |
| 49 | + |
| 50 | +## Design Principles Checked |
| 51 | + |
| 52 | +- DP1: Document consultation transparency |
| 53 | +- DP2: Parameter specification and ordering |
| 54 | +- DP3: Description conciseness (≤500 tokens) |
| 55 | +- DP4: Dependencies declaration |
| 56 | +- DP5: Human-in-the-loop for critical skills |
| 57 | +- DP6: Mandatory sections (Prerequisites, When to Use, Workflow) |
| 58 | +- DP7: Credential security (avoid echoing env vars) |
0 commit comments