Skip to content

Commit 3089e81

Browse files
committed
Explanatory content
1 parent 200405b commit 3089e81

File tree

1 file changed

+26
-9
lines changed

1 file changed

+26
-9
lines changed

.github/README.github.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,53 @@
1-
# Github Configuration
1+
# GitHub Configuration
22

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.
411

512
### Copying Copilot Customisations
613

714
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.
815

9-
## Github Copilot Customisation
16+
## GitHub Copilot Customisation
1017

1118
The [copilot-instructions.md](copilot-instructions.md) file contains the main instructions for Github Copilot.
1219

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)
1423

1524
### Custom Chat Modes
1625

1726
- [Custom Chat Modes](./chatmodes/README.md)
1827

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.
2029

2130
### Custom Instructions
2231

2332
- [Custom Instructions](./instructions/README.md)
2433

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`)
2639

2740
### Custom Prompts
2841

2942
- [Custom Prompts](./prompts/README.md)
3043

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
3247

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.
3449

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)
3653

0 commit comments

Comments
 (0)