Overview

An example skill showing how to structure a plugin skill file, use @include for conventions, and follow a defined workflow. It guides reading ARGUMENTS, searching files, and summarizing results per CONVENTIONS.md, with changes applied through Edit or Write when needed.

How This Skill Works

The skill declares metadata (name, description, allowed-tools, model) and pulls conventions with @include ./CONVENTIONS.md. When invoked, it reads ARGUMENTS, uses Glob to locate files, Grep to search within them, then summarizes results according to the included conventions and applies changes using Edit or Write if requested.

When to Use It

• Demonstrate a standard skill file layout and @include usage for onboarding
• Show how to read user arguments and search a codebase for matches
• Illustrate summarizing findings per an external CONVENTIONS.md
• Provide a ready-made flow for applying changes with Edit/Write
• Educate contributors on plugin development best practices

Quick Start

1. Step 1: @include ./CONVENTIONS.md to import rules
2. Step 2: Read ARGUMENTS and search codebase with Glob/Grep for matches
3. Step 3: Summarize results per conventions and apply changes with Edit or Write

Best Practices

• Anchor summaries to the conventions in CONVENTIONS.md
• Keep ARGUMENTS handling strict to avoid false positives
• Limit scope with glob patterns to relevant directories
• Document every step to reproduce results
• Validate changes using Edit or Write only when requested

Example Use Cases

• A new team member uses the skill to learn the project’s convention workflow
• A PR demonstrates how to summarize findings per CONVENTIONS.md
• A CI job exercises the skill to verify adherence to conventions
• An onboarding doc includes the example to teach file structure
• A plugin author demonstrates end-to-end search and edit cycle

Frequently Asked Questions