Skip to content

Improve agent skills instructions with quality authoring patterns#1232

Open
yeelam-gordon wants to merge 4 commits intogithub:stagedfrom
yeelam-gordon:improve-agent-skills-instructions
Open

Improve agent skills instructions with quality authoring patterns#1232
yeelam-gordon wants to merge 4 commits intogithub:stagedfrom
yeelam-gordon:improve-agent-skills-instructions

Conversation

@yeelam-gordon
Copy link
Copy Markdown
Contributor

@yeelam-gordon yeelam-gordon commented Mar 31, 2026

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have read and followed the Guidance for submissions involving paid services.
  • My contribution adds a new instruction, prompt, agent, skill, or workflow file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, agent, skill, or workflow with GitHub Copilot.
  • I have run npm start and verified that README.md is up to date.
  • I am targeting the staged branch for this pull request.

Description

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 (not only .copilot or .claude)
  • 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

Type of Contribution

  • Update to existing instruction, prompt, agent, plugin, skill, or workflow.

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.

Copilot AI review requested due to automatic review settings March 31, 2026 01:04
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 applyTo to target all **/skills/**/SKILL.md paths.
  • 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.

Copy link
Copy Markdown
Contributor

@aaronpowell aaronpowell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

yeelam-gordon and others added 3 commits April 2, 2026 18:28
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>
@yeelam-gordon yeelam-gordon force-pushed the improve-agent-skills-instructions branch 2 times, most recently from c5dc42e to cc9eeac Compare April 2, 2026 10:36
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>
@yeelam-gordon yeelam-gordon force-pushed the improve-agent-skills-instructions branch from cc9eeac to d4211f2 Compare April 2, 2026 10:39
@yeelam-gordon
Copy link
Copy Markdown
Contributor Author

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.

Thanks @aaronpowell , I rollback and make the term consistent to use "copilot" now ;-) Please for helping on review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants