Improve agent skills instructions with quality authoring patterns#1232
Improve agent skills instructions with quality authoring patterns#1232yeelam-gordon wants to merge 4 commits intogithub:stagedfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the repo’s agent-skill authoring instructions to provide more practical guidance and broader applicability across skill folder layouts.
Changes:
- Broadens
applyToto target all**/skills/**/SKILL.mdpaths. - Adds detailed recommended SKILL.md body sections (including “Gotchas”) with examples and quality principles.
- Refactors and expands the validation checklist and common workflow execution guidance.
aaronpowell
left a comment
There was a problem hiding this comment.
I think there is a level of merit in here with the new additions, but there's a lot of superfluous changes - while, yes, skills are portable this repo is optimised for working with GitHub Copilot so it stands to reason that it uses Copilot as the terminology.
Add practical, platform-agnostic authoring guidance to agent-skills.instructions.md based on community best practices: - Expand applyTo to cover all skills/**/SKILL.md paths - Add writing guidance for every recommended body section with examples (When to Use, Prerequisites, Step-by-Step Workflows, Gotchas, Troubleshooting, References) - Add 'Writing High-Impact Skills' section with 5 principles: - Focus on what the agent doesn't know - Context budget awareness for descriptions - Gotchas as highest-signal content - Flexible guidelines over rigid steps - Progressive disclosure for large skills - Fix description constraints: add 10-char minimum, single-quote wrapping - Reconcile Step-by-Step Workflows with Flexible Guidelines advice - Consolidate Workflow Execution Pattern under Common Patterns - Standardize terminology (agent vs AI agent) - Align line thresholds (200 soft / 500 hard) - Update validation checklist with new quality criteria Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- Replace 'GitHub Copilot'-specific language with generic 'the agent' - Add skills/<skill-name>/ to Directory Structure table for repo layouts - Fix relative path in flexible guidelines example (./references/) - Update description and intro to be platform-neutral Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
c5dc42e to
cc9eeac
Compare
Restore 'Copilot' and 'AI agent' terminology to match the original doc's conventions. Keep new substantive content (Writing High-Impact Skills, Gotchas, expanded examples). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
cc9eeac to
d4211f2
Compare
Thanks @aaronpowell , I rollback and make the term consistent to use "copilot" now ;-) Please for helping on review. |
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.stagedbranch for this pull request.Description
Add practical, platform-agnostic authoring guidance to agent-skills.instructions.md based on community best practices:
Type of Contribution
Additional Notes
Here is the reference for improvement:
https://www.linkedin.com/pulse/lessons-from-building-claude-code-how-we-use-skills-thariq-shihipar-iclmc/
https://www.toolmesh.ai/news/anthropic-engineer-details-claude-code-skills-best-practices
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.