Add generate-copilot-instructions skill#1104
Add generate-copilot-instructions skill#1104charlie-cao wants to merge 1 commit intogithub:stagedfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new Agent Skill, generate-copilot-instructions, intended to help users generate a tailored .github/copilot-instructions.md either by scanning an attached codebase or by running a guided questionnaire.
Changes:
- Introduces a new skill definition at
skills/generate-copilot-instructions/SKILL.md. - Documents an auto-detect workflow (stack/linter/tests/architecture detection) and a guided workflow (8-question intake).
- Defines an output structure and examples for producing a ready-to-paste
.github/copilot-instructions.md.
| ## Objectives | ||
|
|
||
| 1. Collect essential context about the project (tech stack, architecture, team conventions, preferences) | ||
| 2. Generate a structured `copilot-instructions.md` aligned with the project's actual needs |
There was a problem hiding this comment.
The skill alternates between referring to the output file as copilot-instructions.md and .github/copilot-instructions.md. For clarity (and to avoid generating the file in the wrong location), it should consistently reference the full intended path everywhere (Objectives, examples, and prompts).
| 2. Generate a structured `copilot-instructions.md` aligned with the project's actual needs | |
| 2. Generate a structured `.github/copilot-instructions.md` aligned with the project's actual needs |
| ## Configuration | ||
|
|
||
| | Parameter | Values | Default | | ||
| |-----------|--------|---------| | ||
| | **Codebase** | `#codebase`, `#file`, or folder | Optional — triggers auto-detection | | ||
| | **Verbosity** | `concise` (bullets only) or `detailed` (with explanations) | `concise` | | ||
| | **Tone** | `strict` (rules only) or `flexible` (preferred patterns with context) | `flexible` | | ||
|
|
There was a problem hiding this comment.
The “Configuration” section introduces parameters (Verbosity/Tone), but the skill never defines how the user supplies them (e.g., prompt syntax, slash-command args, or explicit Q&A). Consider adding a brief rule like “If the user specifies ‘verbosity: detailed’ …” and/or include an example invocation showing these options so the configuration is actionable.
| --- | ||
| name: generate-copilot-instructions | ||
| description: 'Generate a well-structured .github/copilot-instructions.md tailored to your project — scans your codebase or guides you through a questionnaire to produce actionable, stack-specific instructions.' | ||
| --- |
There was a problem hiding this comment.
Adding a new skill also requires regenerating the generated docs table in docs/README.skills.md (it’s produced by the repo’s README generation script). Please run the repo build/README update step and commit the resulting README.skills.md change so the new skill appears in the skills index and CI doesn’t fail on stale generated docs.
Summary
Adds a new
generate-copilot-instructionsskill that creates a tailored.github/copilot-instructions.mdfor any project.What the skill does
#codebaseor files, it scanspackage.json,pyproject.toml,go.mod, linter configs, and test frameworks to build a picture of the stack automatically.copilot-instructions.mdcovering the five proven high-signal sections — Tech Stack, Code Style, Architecture Rules, Testing Conventions, and Forbidden Patterns.Why upload this skill
copilot-instructions.mdis one of the highest-leverage files in any AI-assisted codebase, but most developers don't know where to start or what to include. This skill removes that friction and produces instructions that are concrete, stack-specific, and immediately actionable — unlike generic prompts that repeat broad guidance the model already knows.Checklist
namefrontmatter (generate-copilot-instructions)descriptionis clear, non-empty, and non-genericnpm run skill:validateandnpm run build— CI will run these automatically on the PR