skill-template
Template for creating new skills following VS Code Agent Skills standard
SKILL.md
| Name | skill-template |
| Description | Template for creating new skills following VS Code Agent Skills standard |
name: _skill-template maintainer: true description: Template for creating new skills following VS Code Agent Skills standard
{{SKILL_NAME}}
When to Use This Skill
Trigger words:
- {{TRIGGER_WORD_1}}
- {{TRIGGER_WORD_2}}
- {{TRIGGER_WORD_3}}
Use this skill when:
- {{USE_CASE_1}}
- {{USE_CASE_2}}
- {{USE_CASE_3}}
Prerequisites
Before starting, ensure:
- {{PREREQUISITE_1}}
- {{PREREQUISITE_2}}
- {{PREREQUISITE_3}}
Required knowledge:
- {{KNOWLEDGE_1}}
- {{KNOWLEDGE_2}}
Required tools:
- {{TOOL_1}}
- {{TOOL_2}}
Step-by-Step Workflow
Step 1: {{STEP_1_TITLE}}
Goal: {{STEP_1_GOAL}}
Actions:
- {{STEP_1_ACTION_1}}
- {{STEP_1_ACTION_2}}
- {{STEP_1_ACTION_3}}
Example:
{{STEP_1_EXAMPLE}}
Validation:
{{STEP_1_VALIDATION_CMD}}
Expected output: {{STEP_1_EXPECTED_OUTPUT}}
Step 2: {{STEP_2_TITLE}}
Goal: {{STEP_2_GOAL}}
Actions:
- {{STEP_2_ACTION_1}}
- {{STEP_2_ACTION_2}}
Example:
{{STEP_2_EXAMPLE}}
Step 3: {{STEP_3_TITLE}}
Goal: {{STEP_3_GOAL}}
Actions:
- {{STEP_3_ACTION_1}}
- {{STEP_3_ACTION_2}}
Final Validation
Run these commands to verify everything works:
{{FINAL_VALIDATION_CMD_1}}
{{FINAL_VALIDATION_CMD_2}}
{{FINAL_VALIDATION_CMD_3}}
Expected results:
- ✅ {{EXPECTED_RESULT_1}}
- ✅ {{EXPECTED_RESULT_2}}
- ✅ {{EXPECTED_RESULT_3}}
Common Pitfalls
Pitfall 1: {{PITFALL_1_NAME}}
Problem: {{PITFALL_1_DESCRIPTION}}
Symptom: {{PITFALL_1_SYMPTOM}}
Solution: {{PITFALL_1_SOLUTION}}
Example:
// ❌ Wrong
{{PITFALL_1_WRONG_EXAMPLE}}
// ✅ Correct
{{PITFALL_1_CORRECT_EXAMPLE}}
Pitfall 2: {{PITFALL_2_NAME}}
Problem: {{PITFALL_2_DESCRIPTION}}
Solution: {{PITFALL_2_SOLUTION}}
Rollback Procedure
If something goes wrong:
- {{ROLLBACK_STEP_1}}
- {{ROLLBACK_STEP_2}}
- {{ROLLBACK_STEP_3}}
Verification:
{{ROLLBACK_VERIFICATION_CMD}}
Examples
Example 1: {{EXAMPLE_1_TITLE}}
Scenario: {{EXAMPLE_1_SCENARIO}}
Steps taken:
- {{EXAMPLE_1_STEP_1}}
- {{EXAMPLE_1_STEP_2}}
- {{EXAMPLE_1_STEP_3}}
Result: {{EXAMPLE_1_RESULT}}
Code:
{{EXAMPLE_1_CODE}}
Example 2: {{EXAMPLE_2_TITLE}}
Scenario: {{EXAMPLE_2_SCENARIO}}
Outcome: {{EXAMPLE_2_OUTCOME}}
References
Related documentation:
Related skills:
External resources:
- {{EXTERNAL_RESOURCE_1}}
- {{EXTERNAL_RESOURCE_2}}
Customization Instructions
To create a skill from this template:
-
Copy this directory:
cp -r .github/skills/_skill-template .github/skills/your-skill-name -
Replace all {{PLACEHOLDERS}} with actual content:
{{SKILL_NAME}}- Name of your skill{{TRIGGER_WORD_*}}- Words that should trigger this skill{{STEP_*_TITLE}}- Step names{{*_EXAMPLE}}- Real code examples{{*_CMD}}- Actual commands to run- etc.
-
Remove/add steps as needed for your workflow
-
Fill in examples with real scenarios from your project
-
Test the workflow by following the steps yourself
-
Update AGENTS.md to map trigger words to this skill
-
Delete this "Customization Instructions" section
Part of the Knowledge System Template. See README for full documentation.