diff --git a/CONTRIBUTING-SKILLS.md b/CONTRIBUTING-SKILLS.md index 7cbb973..cdbf9a4 100644 --- a/CONTRIBUTING-SKILLS.md +++ b/CONTRIBUTING-SKILLS.md @@ -111,6 +111,11 @@ Your skill becomes available as `/:your-skill-name` for anyone who Here's an example `summarize` skill — the entire file: ```markdown +--- +name: summarize +description: Summarize code, files, PRs, or directories for a mixed audience +--- + Provide clear, concise summaries of code, files, pull requests, or entire directories. Write for a mixed audience of designers, developers, and stakeholders. @@ -138,7 +143,16 @@ developers, and stakeholders. - Shorter is better. ``` -That's it. No frontmatter required. No code. No config. Just instructions in markdown. +We recommend adding YAML frontmatter with a `name` and `description` to every SKILL.md. While skills are discovered by directory path, frontmatter improves compatibility with third-party tooling: + +```yaml +--- +name: summarize +description: Summarize code, files, PRs, or directories for a mixed audience +--- +``` + +After the frontmatter, it's just instructions in markdown. No code. No config. ## Skill ideas to get you started diff --git a/plugins/pf-react/skills/unit-test-generator/SKILL.md b/plugins/pf-react/skills/unit-test-generator/SKILL.md index ac2c7b7..ecd5b81 100644 --- a/plugins/pf-react/skills/unit-test-generator/SKILL.md +++ b/plugins/pf-react/skills/unit-test-generator/SKILL.md @@ -1,3 +1,8 @@ +--- +name: unit-test-generator +description: Generate a comprehensive unit test file for a given React component +--- + Generate a comprehensive unit test file for the given React component. ## Input