Skip to content

Add guidance on keeping skill descriptions general#1635

Merged
nathanjmcdougall merged 2 commits into
mainfrom
copilot/update-agent-config-description
Mar 29, 2026
Merged

Add guidance on keeping skill descriptions general#1635
nathanjmcdougall merged 2 commits into
mainfrom
copilot/update-agent-config-description

Conversation

Copilot AI commented Mar 29, 2026

Copy link
Copy Markdown
Contributor

Skill descriptions were being written too narrowly, focusing on one specific aspect rather than the skill's broad topic. This adds guidance to the usethis-skills-create skill on how to formulate the description: frontmatter field.

  • New guidance paragraph in "Writing the description" section: keep descriptions general, ask "what might be added to this skill in the future?"
  • Good/bad examples contrasting broad vs. narrow descriptions:
    • "Maintain AGENTS.md and agent skill configuration"
    • "Enforce the one-source-of-truth principle for AGENTS.md"
  • Quality checklist item added: "Description is general — covers the broad topic, not just one specific aspect"

📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

…create

Add a paragraph and examples to the "Writing the description" section
explaining that descriptions should cover the broad topic of the skill,
not focus on one specific aspect. Also add a corresponding quality
checklist item and bump the skill version to 1.4.

Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/f4c422aa-c175-4363-9955-39a106d977bf

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot AI changed the title [WIP] Update agent config to generalize description field for skills Add guidance on keeping skill descriptions general Mar 29, 2026
Copilot AI requested a review from nathanjmcdougall March 29, 2026 22:34
@nathanjmcdougall nathanjmcdougall marked this pull request as ready for review March 29, 2026 23:05
@nathanjmcdougall nathanjmcdougall merged commit c977e8c into main Mar 29, 2026
1 check passed
@nathanjmcdougall nathanjmcdougall deleted the copilot/update-agent-config-description branch March 29, 2026 23:07
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.

Agent config to explain how to formulate the description: field in skills

2 participants