refactor: nest skill references per agentskills.io spec#207
Conversation
Move 45 reference .md files from flat skill roots into per-skill references/ subdirectories. Existing subdirectories (templates/, evaluations/, examples/) remain as siblings. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…tories Update ~70 markdown links across 14 SKILL.md files from flat paths (file.md) to nested paths (references/file.md). Update cross-skill links in tdd-cycle to use new refactor-clean/references/ path. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…cumentation Update 6 documentation files to reflect the new nested references/ convention: CLAUDE.md, file-organization.md, agent-vs-skill-structure.md, plugin-structure-comparison.md, common-issues.md, and validate-config.py. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Move map-codebase/templates/ → assets/ (static resources per spec). Move vc-ship/examples/ and evaluations/ → references/ (documentation agents read on demand). Update all affected links in SKILL.md files. Spec: https://agentskills.io/specification#optional-directories Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Link all vc-ship reference files from SKILL.md (10 orphaned after examples/ and evaluations/ merge into references/) - Add Reference Files section to claude-md-improver linking update-guidelines.md - Improve tdd-cycle description: add "what it does" before trigger list - Improve tech-debt description: add "what it does" before trigger list Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Remove #fragment anchors from tdd-cycle internal links (validator limitation) - Rewrite 8 keyword-list descriptions to prose style (cc-check, cc-plan, claude-md-improver, improve-instructions, map-codebase, refactor-clean, session-review, vc-ship) - Remove non-standard frontmatter fields (argument-hint from cc-plan, version from vc-ship) All 14 skills now pass skill-validator check. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…io spec - Convert all 14 skills from YAML array to space-delimited string for allowed-tools (spec-compliant, more portable across agent implementations) - Fix stale flat-file paths in skill-improve examples (references/ prefix) - Add word/token-count awareness alongside line metrics in cc-lint, skill-improve, and skill-quality (<5k words per spec) - Add keyword-list description anti-pattern to cc-lint and skill-improve evaluation criteria - Update allowed-tools examples in reference files to space-delimited format Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- CLAUDE.md: remove Output Styles row from architecture table (dir doesn't exist) - README.md: update counts (16 skills, 11 hooks, 1 agent) - README.md: add missing hooks (protect-secrets.py, log-hook-event.sh) - README.md: fix lifecycle event names (Stop not SessionEnd, Notification not OnIdle) - README.md: remove /create-output-style reference - .gitignore: add reflections/ and mcp-needs-auth-cache.json Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Dead config — model is not a spec field and commented YAML has no effect. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
@claude Take a look at this one. |
|
Claude finished @philoserf's task in 2m 11s —— View job PR Review: refactor/skill-nested-references
SummaryWell-executed structural refactoring. The commit history is logical and atomic (10 commits, each with a clear scope), the test plan is thorough, and the migration is consistently applied across all 14 skills. A few minor issues worth noting. What's GoodStructural consistency: All 62 reference files correctly moved into Frontmatter cleanup: Removing
Description rewrites: The prose-style rewrites are much better than keyword lists. They read naturally and still contain the trigger phrases. Compare: Cross-skill links updated: Hook unchanged: Issues1. Duplicate The file now ends with two 2. Stale skill count in The document was partially updated — line 391 says "14 total" but the actual count is 16 (matching README). These still say "13":
3. Lost anchor precision in The old links targeted specific anchors within # Before
[RED phase rules](./phase-discipline.md#red-phase)
[GREEN phase rules](./phase-discipline.md#green-phase)
[REFACTOR phase rules](./phase-discipline.md#refactor-phase)
# After
[RED phase rules](./references/phase-discipline.md) ← no anchor
[GREEN phase rules](./references/phase-discipline.md)
[REFACTOR phase rules](./references/phase-discipline.md)The headings in 4. The skill directory example now shows: The agentskills.io spec only allows VerdictThe core refactoring is solid and the test plan confirms structural correctness. Issues 1 and 2 are documentation inconsistencies worth cleaning up before merge; issues 3 and 4 are minor. |
There was a problem hiding this comment.
Pull request overview
This PR refactors the skill content layout to be agentskills.io–spec compliant by moving supporting docs into per-skill references/ subdirectories, updating SKILL frontmatter, and expanding/rewriting several reference docs and quality tooling documentation.
Changes:
- Standardize skills to
SKILL.md+ nestedreferences/(andassets/where applicable), updating internal markdown links accordingly. - Convert
allowed-toolsfrontmatter from YAML arrays to space-delimited strings and simplify/normalize skill descriptions to prose. - Add/refresh reference documentation across multiple skills (workflow examples/protocols, scoring/report templates, test strategy templates, CLAUDE.md improver guidance).
Reviewed changes
Copilot reviewed 30 out of 84 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| skills/vc-ship/SKILL.md | Update frontmatter + repoint all reference links to references/ |
| skills/vc-ship/references/simple-feature.md | Add example workflow reference |
| skills/vc-ship/references/rebase-guide.md | Add rebase safety guidance reference |
| skills/vc-ship/references/protected-branch-protocol.md | Add push-time protected branch protocol reference |
| skills/vc-ship/references/pr-creation.md | Add multi-commit PR creation example |
| skills/vc-ship/references/phase-4.5-protocol.md | Add pre-push quality gate protocol reference |
| skills/vc-ship/references/phase-0-protocol.md | Add start-of-work protected branch protocol reference |
| skills/vc-ship/references/patterns.md | Add key workflow patterns reference |
| skills/vc-ship/references/messy-history.md | Add messy history cleanup example |
| skills/vc-ship/references/large-refactor.md | Add large refactor commit-plan example |
| skills/vc-ship/references/examples-README.md | Add index of vc-ship reference scenarios |
| skills/vc-ship/references/eval-simple-feature.md | Add evaluation scenario reference |
| skills/vc-ship/references/eval-messy-history.md | Add evaluation scenario reference |
| skills/vc-ship/references/eval-large-refactor.md | Add evaluation scenario reference |
| skills/vc-ship/references/commit-format.md | Add commit message format guide reference |
| skills/vc-ship/references/bug-fix.md | Add mixed-change bugfix example reference |
| skills/tech-debt/SKILL.md | Normalize frontmatter + update reference paths |
| skills/tech-debt/references/roi-framework.md | Add ROI scoring framework reference |
| skills/tech-debt/references/debt-categories.md | Add debt taxonomy reference |
| skills/tdd-cycle/SKILL.md | Normalize frontmatter + update reference paths |
| skills/tdd-cycle/references/thresholds.md | Add coverage/metrics thresholds reference |
| skills/tdd-cycle/references/phase-discipline.md | Fix refactor-clean rubric link path |
| skills/skill-quality/SKILL.md | Normalize allowed-tools + update reference paths |
| skills/skill-quality/references/scoring-rubric.md | Extend rubric with word-count thresholds |
| skills/skill-quality/references/report-template.md | Add standardized quality report template |
| skills/skill-quality/references/quality-dimensions.md | Add word-count guidance to dimensions |
| skills/skill-quality/references/examples.md | Add sample assessments reference |
| skills/skill-improve/SKILL.md | Normalize allowed-tools + update reference paths |
| skills/skill-improve/references/report-template.md | Add standardized improvement report template |
| skills/skill-improve/references/prioritization-guide.md | Add prioritization guide reference |
| skills/skill-improve/references/improvement-categories.md | Add keyword-list anti-pattern + word-count guidance |
| skills/skill-improve/references/examples.md | Update examples to new references/ layout + allowed-tools style |
| skills/session-review/SKILL.md | Normalize frontmatter + update reference paths |
| skills/session-review/references/output-template.md | Add reflection output template reference |
| skills/session-review/references/framework.md | Add analysis framework reference |
| skills/refactor-clean/SKILL.md | Normalize frontmatter + update reference paths |
| skills/refactor-clean/references/quality-checklist.md | Add refactor verification checklist reference |
| skills/refactor-clean/references/analysis-rubric.md | Add smell/severity analysis rubric reference |
| skills/map-codebase/SKILL.md | Switch template references to assets/ + normalize frontmatter |
| skills/map-codebase/references/workflow.md | Update workflow instruction to use assets/ templates |
| skills/map-codebase/assets/structure.md | Add STRUCTURE template asset |
| skills/map-codebase/assets/stack.md | Add STACK template asset |
| skills/map-codebase/assets/integrations.md | Add INTEGRATIONS template asset |
| skills/map-codebase/assets/conventions.md | Add CONVENTIONS template asset |
| skills/map-codebase/assets/concerns.md | Add CONCERNS template asset |
| skills/map-codebase/assets/architecture.md | Add ARCHITECTURE template asset |
| skills/improve-instructions/SKILL.md | Normalize frontmatter + update reference paths |
| skills/improve-instructions/references/examples.md | Add CLAUDE.md improvement examples reference |
| skills/improve-instructions/references/analysis-guide.md | Add conversation-pattern analysis guide reference |
| skills/claude-md-improver/SKILL.md | Normalize frontmatter + add/point to new references |
| skills/claude-md-improver/references/update-guidelines.md | Add CLAUDE.md update rules reference |
| skills/claude-md-improver/references/templates.md | Add CLAUDE.md template library reference |
| skills/claude-md-improver/references/quality-criteria.md | Add CLAUDE.md scoring criteria reference |
| skills/claude-automation-recommender/SKILL.md | Normalize allowed-tools + update reference paths |
| skills/claude-automation-recommender/references/subagent-templates.md | Add subagent recommendation templates reference |
| skills/claude-automation-recommender/references/plugins-reference.md | Add plugin catalog reference |
| skills/claude-automation-recommender/references/output-template.md | Add recommendations report template reference |
| skills/claude-automation-recommender/references/mcp-servers.md | Add MCP server recommendation reference |
| skills/claude-automation-recommender/references/hooks-patterns.md | Add hook patterns reference |
| skills/claude-automation-recommender/references/decision-framework.md | Add decision framework reference |
| skills/cc-plan/SKILL.md | Normalize frontmatter + update reference path |
| skills/cc-plan/references/example-prd.md | Add PRD example reference |
| skills/cc-lint/SKILL.md | Normalize allowed-tools + update reference paths |
| skills/cc-lint/references/report-format.md | Add standardized evaluation report format reference |
| skills/cc-lint/references/examples.md | Update examples’ allowed-tools style |
| skills/cc-lint/references/evaluation-process.md | Add evaluation process reference |
| skills/cc-lint/references/evaluation-criteria.md | Add prose-description requirement + word-count guidance |
| skills/cc-lint/references/common-issues.md | Add keyword-list anti-pattern + word-count guidance |
| skills/cc-check/SKILL.md | Normalize frontmatter + update reference paths |
| skills/cc-check/references/test-strategies.md | Add test execution strategies reference |
| skills/cc-check/references/report-template.md | Add test report template reference |
| skills/cc-check/references/examples.md | Add test case examples reference |
| skills/cc-check/references/common-failures.md | Add common test failure catalog reference |
| settings.json | Add gitup to allowed Bash commands |
| references/plugin-structure-comparison.md | Update docs to reflect nested references/ convention |
| references/file-organization.md | Update skill directory guidance to nested references/ convention |
| references/agent-vs-skill-structure.md | Update docs to reflect nested references/ convention |
| hooks/validate-config.py | Clarify skip behavior comment for references paths |
| README.md | Update component counts + remove stale output-style references |
| .gitignore | Ignore reflections/ and MCP auth cache file |
| .claude/CLAUDE.md | Update architecture notes and skill structure guidance |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Address Copilot PR review comments: - file-organization.md: remove templates/ from skill layout, clarify spec - plugin-structure-comparison.md: remove templates/examples/evaluations references, update skill count to 16 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary
references/patternreferences/,assets/,scripts/allowed-toolsfrom YAML arrays to space-delimited strings (spec-portable)argument-hint,version, commented-outmodel)Test plan
.mdfiles at skill roots (only SKILL.md remains)](*.md)targets all resolve)bunx prettier --check skills/passesreferences/files/cc-lintstructural validation passes (0 findings)/cc-checkfunctional tests pass (38/38 links, 4/4 hook tests, 10/10 discovery)skill-validator checkpasses on all 14 skills (0 errors, 0 warnings)🤖 Generated with Claude Code