|
1 | | -# Github Configuration |
| 1 | +# GitHub Configuration |
2 | 2 |
|
3 | | -TODO explain |
| 3 | +This directory contains repository-level configuration and assets that tailor GitHub and GitHub Copilot to this project. It centralizes: |
| 4 | +- Copilot repository instructions and guidance |
| 5 | +- Custom Chat Modes used in Copilot Chat |
| 6 | +- Reusable Prompt files (slash commands) |
| 7 | +- Instruction files for languages/domains |
| 8 | +- GitHub Actions workflows (CI/CD) scaffolding |
| 9 | + |
| 10 | +Audience: maintainers and contributors configuring Copilot or repository automation. |
4 | 11 |
|
5 | 12 | ### Copying Copilot Customisations |
6 | 13 |
|
7 | 14 | The custom chatmodes, instructions and prompts can be copied into the same directory structure of another repository. Each file has comments that explain the approach, structure and content of each file. |
8 | 15 |
|
9 | | -## Github Copilot Customisation |
| 16 | +## GitHub Copilot Customisation |
10 | 17 |
|
11 | 18 | The [copilot-instructions.md](copilot-instructions.md) file contains the main instructions for Github Copilot. |
12 | 19 |
|
13 | | -TODO explain |
| 20 | +It defines mandatory development workflows (branching, commit and PR conventions), coding standards, and review/quality gates using clear, machine-parseable XML-style tags (for example, <CRITICAL_REQUIREMENT/>). Copilot and other AI assistants use these rules to stay consistent with your team’s process. See also: |
| 21 | +- Project overview in [README.md](../README.md) |
| 22 | +- Agent context in [AGENTS.md](../AGENTS.md) |
14 | 23 |
|
15 | 24 | ### Custom Chat Modes |
16 | 25 |
|
17 | 26 | - [Custom Chat Modes](./chatmodes/README.md) |
18 | 27 |
|
19 | | -TODO explain |
| 28 | +Chat Modes provide specialized behaviors in Copilot Chat (e.g., Developer, Code Review, Documentation, Testing, Planner). Each mode documents its persona, process, constraints, and available tools. Pick a mode in Copilot Chat to bias the assistant for the task at hand. Files live under `./chatmodes/` and use the `.chatmode.md` extension. |
20 | 29 |
|
21 | 30 | ### Custom Instructions |
22 | 31 |
|
23 | 32 | - [Custom Instructions](./instructions/README.md) |
24 | 33 |
|
25 | | -TODO explain |
| 34 | +Instruction files are small, focused rule sets with optional frontmatter (e.g., `applyTo`) that scope guidance to specific files or languages. They help Copilot generate code and docs that match project standards. Notable files include: |
| 35 | +- `backend.instructions.md` (Java/Python/C# backends) |
| 36 | +- `frontend.instructions.md` (TypeScript/React conventions) |
| 37 | +- `docs.instructions.md` (applies to all `**/*.md`) |
| 38 | +- `bdd-tests.instructions.md` (applies to `**.feature`) |
26 | 39 |
|
27 | 40 | ### Custom Prompts |
28 | 41 |
|
29 | 42 | - [Custom Prompts](./prompts/README.md) |
30 | 43 |
|
31 | | -TODO explain |
| 44 | +Reusable prompts act like slash commands in Copilot Chat (e.g., `/write-adr`, `/write-prd`, `/write-docs`, `/copilot-setup-check`). They standardize inputs and output structure for common tasks and can create or edit files when approved. |
| 45 | + |
| 46 | +## GitHub Actions Customisation |
32 | 47 |
|
33 | | -## Github Actions Customisation |
| 48 | +The `./workflows/` folder holds GitHub Actions. It’s currently empty and ready for CI/CD jobs (for example: lint Markdown, validate instruction frontmatter, run tests). Add workflow files as needed following standard GitHub Actions practices. |
34 | 49 |
|
35 | | -TODO explain workflows |
| 50 | +References: |
| 51 | +- GitHub Actions docs: https://docs.github.com/actions |
| 52 | +- Copilot repository instructions: [copilot-instructions.md](./copilot-instructions.md) |
36 | 53 |
|
0 commit comments