instruction-creator
Create and manage high-quality custom instruction files for GitHub Copilot. Use when you need to define new project-specific guidelines, workflows, or coding standards in the instructions/ directory.
When & Why to Use This Skill
The Instruction Creator skill streamlines the development process by automating the creation and management of high-quality custom instruction files for GitHub Copilot. It ensures that AI-generated code consistently adheres to project-specific standards, domain logic, and architectural guidelines, significantly improving the relevance and accuracy of AI pair programming suggestions.
Use Cases
- Standardizing Coding Conventions: Automatically generate and maintain boilerplate instruction files to enforce specific naming conventions, file structures, and linting rules across a repository.
- Domain-Specific Logic Integration: Define complex business rules and project-specific logic in the instructions/ directory to guide GitHub Copilot in generating context-aware code.
- Workflow Optimization: Use semantic linking to connect custom instructions with specific automation skills, enabling Copilot to trigger the right scripts for testing, deployment, or code analysis.
- Team Onboarding: Create a centralized 'Policy Maker' for the codebase that helps new developers stay aligned with established project patterns through AI-driven guidance.
| name | instruction-creator |
|---|---|
| description | 'Create and manage high-quality custom instruction files for GitHub Copilot. Use when you need to define new project-specific guidelines, workflows, or coding standards in the instructions/ directory.' |
Instruction Creator
This skill guides the creation of effective custom instruction files that help GitHub Copilot follow project conventions and domain-specific logic.
Workflow
- Define Scope: Identify the purpose and the files the instructions should apply to (e.g.,
**/*.ts). - Initialize: Use the
scripts/init_instruction.pyscript to create the boilerplate.python skills/instruction-creator/scripts/init_instruction.py "my-new-instruction" --description "Description here" --applyTo "**/*.ext" - Draft Content: Follow the guidelines to fill in the sections.
- Use Templates: Refer to templates for standard structures.
- Semantic Linking: Ensure you link to relevant Skills in the
Workflowsection.- Example:
To perform [Task], execute the [Skill Name](skills/<skill-name>/SKILL.md).
- Example:
- Validate: Test the instructions with Copilot to ensure they are clear and actionable.
Core Principles
- Policy Maker: Instructions define the "What" and "How" (decision logic).
- Concise: Avoid fluff; use imperative language.
- Actionable: Provide concrete examples and clear steps.
- Linked: Connect instructions to the skills that execute them.
Resources
- Guidelines: Detailed rules for frontmatter, style, and linking.
- Templates: Ready-to-use markdown structures.
scripts/init_instruction.py: Automation for creating new files.