instructions for humans and agents for testing and code review (#60435) · github/docs@f1bbc65 · GitHub
Skip to content

Commit f1bbc65

Browse files
jmoodyCopilotCopilotCopilot
authored
instructions for humans and agents for testing and code review (#60435)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jmoody <466104+jmoody@users.noreply.github.com>
1 parent 7085640 commit f1bbc65

7 files changed

Lines changed: 484 additions & 29 deletions

File tree

‎.devcontainer/devcontainer.json‎

Lines changed: 2 additions & 1 deletion

‎.github/copilot-instructions.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Copilot instructions for docs.github.com
2+
3+
This repository powers the GitHub Docs site (docs.github.com). It contains both the Next.js application code (TypeScript) and the documentation content (Markdown).
4+
5+
## Instruction files
6+
7+
Read the relevant instruction files in `.github/instructions/` before making changes:
8+
9+
* **`all.instructions.md`** — General project guidelines, PR conventions, and how to access docs.github.com content programmatically. Applies to all files.
10+
* **`code.instructions.md`** — TypeScript/JavaScript coding standards, test commands (per-suite with environment variables), and validation steps. Read this before any code change.
11+
* **`content.instructions.md`** — Markdown content conventions, Liquid variable usage, reusables, and linking with `[AUTOTITLE]`. Read this before any content change.
12+
* **`style-guide-summary.instructions.md`** — Condensed docs style guide covering voice, headers, lists, alerts, and formatting. Read this before any content change.
13+
14+
## Key rules
15+
16+
* All new code must be TypeScript (not JavaScript).
17+
* Use `@/` absolute imports (e.g., `import getRedirect from '@/redirects/lib/get-redirect'`).
18+
* Do not run `npm test` without a path argument — always target a specific suite.
19+
* Run `npm run build` before running tests.
20+
* Do not commit to `main`. Create a branch and open a draft PR.
21+
* Use Liquid variables for product names — never hardcode them. Check `data/variables/`.
22+
* Use `[AUTOTITLE](/path/to/article)` for internal links — never hardcode article titles.

‎.github/instructions/code.instructions.md‎

Lines changed: 45 additions & 5 deletions

0 commit comments

Comments
 (0)