Skip to content

feat(skill-development): add examples directory with skill templates#43

Merged
sjnims merged 1 commit intomainfrom
feat/40-skill-development-examples
Dec 8, 2025
Merged

feat(skill-development): add examples directory with skill templates#43
sjnims merged 1 commit intomainfrom
feat/40-skill-development-examples

Conversation

@sjnims
Copy link
Copy Markdown
Owner

@sjnims sjnims commented Dec 8, 2025

Description

Add examples/ directory to the skill-development skill, making it consistent with all other plugin-dev skills. The skill now "practices what it preaches" by providing working skill templates that users can copy.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (improvements to README, CLAUDE.md, or component docs)
  • Refactoring (code change that neither fixes a bug nor adds a feature)
  • Configuration change (changes to .markdownlint.json, plugin.json, etc.)

Component(s) Affected

  • Commands (/plugin-dev:*)
  • Skills (methodology and best practices)
  • Agents (requirements-assistant)
  • Hooks (UserPromptSubmit)
  • Documentation (README.md, CLAUDE.md, SECURITY.md)
  • Configuration (.markdownlint.json, plugin.json, marketplace.json)
  • Issue/PR templates
  • Other (please specify):

Motivation and Context

The skill-development skill was the only skill in plugin-dev without an examples/ directory. This was inconsistent since:

  1. All other skills have examples/
  2. The skill teaches "Provide working examples" as a best practice but didn't follow its own guidance
  3. New skill creators had to piece together examples from other skills

Fixes #40

How Has This Been Tested?

Test Configuration:

  • Claude Code version: latest
  • GitHub CLI version: 2.63.2
  • OS: macOS (Darwin 25.1.0)

Test Steps:

  1. Verified markdownlint passes on all new files
  2. Verified examples follow documented best practices (third-person description, imperative body)
  3. Confirmed SKILL.md references new examples correctly

Checklist

General

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas (if applicable)
  • My changes generate no new warnings or errors

Documentation

  • I have updated the documentation accordingly (README.md, CLAUDE.md, or component docs)
  • I have updated YAML frontmatter (if applicable)
  • I have verified all links work correctly

Markdown

  • I have run markdownlint and fixed all issues
  • My markdown follows the repository style (ATX headers, dash lists, fenced code blocks)
  • I have verified special HTML elements are properly closed (<example>, <commentary>, etc.)

Component-Specific Checks

Skills (if applicable)

  • Description uses third-person with specific trigger phrases
  • SKILL.md is under 2,000 words (progressive disclosure)
  • Detailed content is in references/ subdirectory
  • Templates follow the established format

Testing

  • I have tested the plugin locally with cc --plugin-dir plugins/plugin-dev
  • I have tested the full workflow (if applicable)
  • I have verified GitHub CLI integration works (if applicable) - N/A
  • I have tested in a clean repository (not my development repo) - N/A

Changes

New Files

  • examples/minimal-skill.md - Bare-bones skill template (git conventions example)
  • examples/complete-skill.md - Full skill with references/, examples/, scripts/ (API testing example)
  • examples/frontmatter-templates.md - Copy-paste frontmatter templates for common patterns

Modified Files

  • SKILL.md - Added "Example Skills" section under Additional Resources

Additional Notes

Examples follow the documentation-style pattern used by other skills (e.g., plugin-structure/examples/minimal-plugin.md), where each example is a markdown file that documents the skill structure with embedded code blocks, rather than actual nested directories.


🤖 Generated with Claude Code

Add examples/ directory to skill-development skill, making it consistent
with all other plugin-dev skills. The skill now "practices what it preaches"
by providing working examples that users can copy.

Examples include:
- minimal-skill.md: Bare-bones skill with just SKILL.md
- complete-skill.md: Full skill with all optional components
- frontmatter-templates.md: Quick-reference copy-paste templates

Also updates SKILL.md Additional Resources section to reference the new
examples directory.

Fixes #40

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
Copy link
Copy Markdown

claude Bot commented Dec 8, 2025

Claude finished @sjnims's task —— View job


PR Review Complete ✅

Summary

Looks excellent! This PR successfully adds the missing examples/ directory to skill-development, making it consistent with all other plugin-dev skills. The examples are well-structured, follow documented best practices, and provide valuable copy-paste templates for skill creators.


What's Good

1. Addresses Real Inconsistency

  • skill-development was the only skill without examples/ - this PR fixes that
  • Now "practices what it preaches" by demonstrating its own guidance

2. High-Quality Examples

  • minimal-skill.md: Perfect bare-bones template (git conventions)
    • Clear structure with just SKILL.md
    • Shows proper frontmatter format (third-person description, quoted triggers)
    • Good "when to use" guidance
  • complete-skill.md: Comprehensive template (API testing)
    • Demonstrates all optional components (references/, examples/, scripts/)
    • Shows progressive disclosure in action
    • Working code examples are executable
    • Good cross-referencing pattern between SKILL.md and references/
  • frontmatter-templates.md: Practical quick-reference
    • Copy-paste ready templates for common patterns
    • Includes do's and don'ts section
    • Covers security-focused skills, read-only skills, multi-domain skills

3. Proper Documentation Style

  • Examples follow the documentation pattern (markdown files with embedded code blocks)
  • Consistent with other skills like plugin-structure/examples/minimal-plugin.md
  • Each example includes "Key Points" and "When to Use This Pattern" sections

4. Writing Quality

  • All frontmatter uses third-person ("This skill should be used when...")
  • All skill bodies use imperative form ("Follow...", "Use...", not "You should...")
  • Trigger phrases are properly quoted
  • Content is focused and well-organized

5. Integration

  • SKILL.md properly references new examples in "Additional Resources" section
  • References are formatted consistently with existing structure
  • Clear hierarchy: Examples → Reference Files → Study These Skills

Markdown Linting

All files pass markdownlint with no errors or warnings


Checklist Verification

The PR checklist is thoroughly completed:

General: Code follows style guidelines, self-reviewed, no new warnings
Documentation: SKILL.md updated with examples section, frontmatter verified, links work
Markdown: markdownlint passes, follows repository style (ATX headers, dash lists, fenced code blocks)
Skills: Third-person descriptions ✓, Under 2,000 words ✓, Progressive disclosure ✓, Template format ✓
Testing: Tested locally with cc --plugin-dir


Suggestions

None! This PR is ready to merge as-is. The examples are:

  • Well-structured and follow best practices
  • Properly integrated into SKILL.md
  • Consistent with repository patterns
  • Immediately useful for skill creators

The complete-skill.md example is particularly valuable - it shows a realistic skill with all components working together, not just abstract descriptions.


Final Assessment

Approve and merge - This is a solid contribution that improves the skill-development skill by providing the practical examples it was missing. Great work! 🎉


@sjnims sjnims self-assigned this Dec 8, 2025
@claude claude Bot added enhancement New feature or request component:skill Skills layer effort:small < 1 hour documentation Improvements or additions to documentation labels Dec 8, 2025
@sjnims sjnims merged commit 7dbb4e5 into main Dec 8, 2025
8 checks passed
@sjnims sjnims deleted the feat/40-skill-development-examples branch December 8, 2025 04:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component:skill Skills layer documentation Improvements or additions to documentation effort:small < 1 hour enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(skill-development): add examples directory with skill templates

1 participant