feat: add GitHub Copilot instructions for contributors - #470
Conversation
There was a problem hiding this comment.
Pull request overview
Adds first-class GitHub Copilot contributor support to this repository by introducing repo-wide and path-specific Copilot instruction/prompt files, and documenting how AI-DLC workflows map onto Copilot surfaces (Ask/Plan/Agent, CLI, cloud agent). This complements the existing contributor configuration for other agents (e.g., .claude/, .kiro/steering/) and improves discoverability in existing docs.
Changes:
- Add repository-wide Copilot instructions plus path-scoped instruction files for
aidlc-rules/**,scripts/aidlc-evaluator/**, anddocs/**. - Add reusable Copilot prompt files (
/new-rule,/security-finding-triage) to standardize common contributor workflows. - Add a dedicated Copilot integration guide and link it from existing contributor documentation and the README.
Show a summary per file
| File | Description |
|---|---|
| README.md | Expands Copilot setup guidance, including recommended surfaces/modes and links to the new integration guide. |
| docs/GITHUB-COPILOT-INTEGRATION.md | New guide describing Copilot customization mechanisms and surface compatibility with AI-DLC runtime behavior. |
| AGENTS.md | Adds the new Copilot integration guide to the documentation map. |
| .github/copilot-instructions.md | New always-on Copilot context distilled for repo contributors. |
| .github/instructions/aidlc-rules.instructions.md | Adds path-scoped guidance for contributors editing the distributable aidlc-rules/** content. |
| .github/instructions/scripts.instructions.md | Adds path-scoped guidance for the Python evaluator subtree (uv/pytest + scanner conventions). |
| .github/instructions/docs.instructions.md | Adds path-scoped guidance for editing human-facing docs under docs/. |
| .github/prompts/new-rule.prompt.md | New reusable prompt to scaffold rule detail files under aidlc-rules/. |
| .github/prompts/security-finding-triage.prompt.md | New reusable prompt to triage scanner findings and apply fixes/suppressions correctly. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 9/9 changed files
- Comments generated: 3
- Review effort level: Low
| - Always add a language to fenced code blocks (MD040 is enforced). | ||
| - Keep table pipes vertically aligned (MD060 `aligned` is enforced). |
Add .github/copilot-instructions.md so contributors who use GitHub Copilot to work on this repository get the same project context that Claude Code and Kiro already receive (build/test/lint commands, code style, PR rules, security scanners, and the do-not-rename public-contract constraints). Content is a concise subset of AGENTS.md. Scope is intentionally limited to contributor tooling for the current repo; it does not expand the product's platform support. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
6c99e04 to
d2995d7
Compare
Rescoped to avoid conflicting with the v2 directionAfter reviewing the repository's direction, I've significantly reduced the scope of this PR. What I found:
What changed in this PR as a result:
Happy to close this entirely if maintainers prefer, or to instead open a discussion about a proper v2 Copilot harness (and the hook/subagent primitives that would be prerequisites). |
Correction / addendum: Copilot's 2026 extensibility (my earlier comment was too pessimistic)My previous comment stated that "the v2 harness contract requires programmable hooks, subagents, and a local Bun runtime that Copilot's custom-instructions model does not provide." After a deeper look at the current (2026) GitHub Copilot documentation, that claim is out of date and I want to correct it for the record. Copilot now provides the primitives the v2 harness contract needs — most notably on the Copilot CLI (GA):
Status caveats: hooks are Preview in VS Code (and VS Code currently ignores hook matchers + uses different tool names, so an adapter shim must normalize them), and the cloud agent is a poor fit for AI-DLC's interactive approval gates (it runs autonomously to a PR, has an ephemeral FS, and doesn't ship Net: a This does not change this PR. #470 stays correctly scoped to contributor tooling ( |
Summary
Add
.github/copilot-instructions.mdso contributors who use GitHub Copilotto work on this repository get the same project context that Claude Code
(
.claude/) and Kiro (.kiro/steering/) already receive. Content is a concisesubset of
AGENTS.md(build/test/lint commands, code style, PR rules, securityscanners, and the do-not-rename public-contract constraints).
Changes
.github/copilot-instructions.md— repository-wide Copilot context for contributors.User experience
unlike Claude Code and Kiro contributors.
PR rules, constraints) from
.github/copilot-instructions.md.Checklist
Test Plan
npx markdownlint-cli2 ".github/copilot-instructions.md"passes (0 errors)..gitignorechange needed —.github/**is version-controlled.aidlc-rules/content touched.Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.