Skip to content

docs: standardize skill descriptions to lead with triggers - #124

Merged
WilliamBergamin merged 2 commits into
mainfrom
standardize-skill-description
Aug 20, 2026
Merged

docs: standardize skill descriptions to lead with triggers#124
WilliamBergamin merged 2 commits into
mainfrom
standardize-skill-description

Conversation

@WilliamBergamin

@WilliamBergamin WilliamBergamin commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Summary

This pull request standardizes every skill's description frontmatter so the right skill loads more reliably for a given task. Resolves #123.

  • Rewrites all 7 skill descriptions to lead with a "Use when …" trigger, in impersonal voice, dropping workflow-summary phrasing while keeping their Slack-specific keywords.
  • Documents the 7-point description convention in the maintainers guide, linked from AGENTS.md.
  • Adds frontmatter unit checks: description length cap (≤ 1024), trigger cue, and impersonal voice.

Preview

N/A — text and frontmatter changes only.

Testing

  • Skim the 7 rewritten descriptions and the new "Authoring Skills" section in the maintainers guide for accuracy.
  • Local checks pass: make lint, make typecheck, and make test-unit (21/21, including the 3 new description checks). make test-eval was not run locally (needs a Gemini API key); CI runs it.

Requirements

Rewrite all 7 skill descriptions to lead with "Use when" triggers, drop first/second-person and workflow-summary phrasing, and keep their Slack-specific keywords so the right skill loads more reliably. Document the convention in the maintainers guide (linked from AGENTS.md) and add frontmatter unit checks (length cap, trigger cue, impersonal voice).

Resolves #123

Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
@changeset-bot

changeset-bot Bot commented Aug 19, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: bf1054c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
slack Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@WilliamBergamin WilliamBergamin self-assigned this Aug 19, 2026
@WilliamBergamin WilliamBergamin added semver:patch Changes trigger a patch version bump area:skills Skills and slash commands loaded by the plugin labels Aug 19, 2026
@WilliamBergamin
WilliamBergamin marked this pull request as ready for review August 19, 2026 17:31
@WilliamBergamin
WilliamBergamin requested a review from a team as a code owner August 19, 2026 17:31

@mwbrooks mwbrooks left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

✅ Love this direction, thanks @WilliamBergamin!

@WilliamBergamin
WilliamBergamin merged commit 1251c73 into main Aug 20, 2026
7 checks passed
@WilliamBergamin
WilliamBergamin deleted the standardize-skill-description branch August 20, 2026 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:skills Skills and slash commands loaded by the plugin semver:patch Changes trigger a patch version bump

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Standardize skill description fields conventions

2 participants