Conversation
Skills use SKILL.md as the primary documentation file. The README.md duplicated content already present in SKILL.md. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
… syntax Document the `!`command`` syntax required for bash pre-execution in actual command files: - Add "Syntax: The `!` Prefix" section explaining how pre-execution works - Document that `!`command`` executes before Claude sees the prompt - Explain why skill examples omit `!` (would execute when loaded) - Update reference file examples to use `!` prefix consistently Users copying examples from the reference file into actual command files will now have the correct syntax. Fixes #46 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
|
Claude finished @sjnims's task —— View job PR Review Complete ✓SummaryExcellent documentation improvement. This PR successfully addresses issue #46 by clearly documenting the What's Good
Technical AccuracyThe documentation is technically accurate:
Structure and OrganizationThe placement is logical:
SuggestionsMinor observations (not blocking):
Checklist Verification
RecommendationApprove and merge. This is a valuable documentation fix that will prevent user confusion and make the command-development skill more effective. |
There was a problem hiding this comment.
Pull request overview
This PR documents the previously undocumented ! prefix syntax required for bash pre-execution in Claude Code command files. The changes address issue #46 by adding comprehensive documentation to SKILL.md explaining how the !command`` syntax works and why skill examples intentionally omit it. All bash examples in the reference file are updated with the correct ! prefix for copy-paste usage. The redundant README.md file is removed since SKILL.md serves as the primary skill documentation.
Key changes:
- Added 40 lines documenting the
!prefix syntax, execution model, and rationale for omission in skill examples - Updated 21 bash command examples in plugin-features-reference.md to use the correct
!prefix - Removed redundant README.md file (skill documentation is in SKILL.md)
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
plugins/plugin-dev/skills/command-development/SKILL.md |
Added "Syntax: The ! Prefix" section explaining pre-execution syntax and "Why Skill Examples Omit !" section clarifying intentional omission in documentation |
plugins/plugin-dev/skills/command-development/references/plugin-features-reference.md |
Updated all bash command examples to use ! prefix for correct copy-paste usage; improved example output formatting |
plugins/plugin-dev/skills/command-development/README.md |
Removed redundant README.md file as SKILL.md serves as primary skill documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
!command`` syntax required for bash pre-execution in actual command files!(would execute when loaded into context)!prefix for copy-paste useProblem
Fixes #46
The command-development skill didn't document the
!prefix syntax required for bash pre-execution in actual command files. Users following the examples would write\git status`instead of!`git status``, resulting in non-functional commands.Solution
Added "Syntax: The
!Prefix" section to SKILL.md explaining:!command`` syntaxAdded "Why Skill Examples Omit
!" section explaining the intentional omission in skill documentationUpdated all bash examples in
plugin-features-reference.mdto use the!prefix, since users copy these into actual command filesAlternatives Considered
Changes
plugins/plugin-dev/skills/command-development/SKILL.md: Added 40 lines documenting the!prefix syntaxplugins/plugin-dev/skills/command-development/references/plugin-features-reference.md: Updated 21 bash examples to use!prefixTesting
🤖 Generated with Claude Code