- Notifications
You must be signed in to change notification settings - Fork4.9k
docs: Add missing prompt commands + existing project walkthrough#937
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Changes from1 commit
0e32149c69f5d175f86ab83a307a87b71cd787340d2132e7c0b194925a322bc8202820c46b0d6b458ccf16add6c6b4557cFile filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
- Add a minimal Copilot Code Review instruction that references existing `AGENTS.md` files- Add `docs/AGENTS.md` for docs-specific agent guidance (tone, capitalization, argument formats)- The `copilot-instructions.md` file is designed to support auto-Copilot Code Reviews in GitHub- Existing `AGENTS.md` files remain unchanged and the authoritative source for project conventionsCo-authored-by: GitHub Copilot <github.copilot@github.com>Signed-off-by: Ashley Childress <6563688+anchildress1@users.noreply.github.com>
- Loading branch information
Uh oh!
There was an error while loading.Please reload this page.
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # Copilot instructions for automated code reviews 🌱 | ||
| This file provides minimal guidance for Copilot Code Review suggestions on pull requests. Code changes should be judged against the guidelines defined below. | ||
| - Reference [repository-level standards](../AGENTS.md) as the authoritative source for project conventions when reviewing any files changed in this repo. | ||
| - For files under `docs/`, additionally consult the [docs-specific guidance](../docs/AGENTS.md) for additional requirements designed to promote consistency in independent documentation contributions. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # AGENTS.md for Spec Kit documentation | ||
| ## Guidelines for consistent user documentation | ||
| - The correct syntax for this project is "Spec Kit" (two words, capital S and K). Never use any other variation outside of code snippets. | ||
| - Use active voice and present tense where possible. | ||
| - Write for an audience familiar with AI and programming concepts, but new to Spec Kit. | ||
| - Ensure an informal narrative, teaching voice: give a one-line "why" plus a one-line "how" and a minimal, copy‑pastable example/command when helpful. | ||
| ||
| - User documentation files are expected to use kebab-case for the `.md` extension, except for special files like `README.md`. | ||
| - Examples should be copy-pastable in fenced code blocks and accurate; if unsure, prefer not to change examples. | ||