You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/README.github.md
+15-7Lines changed: 15 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,31 +9,39 @@ This directory contains repository-level configuration and assets that tailor Gi
9
9
10
10
Audience: maintainers and contributors configuring Copilot or repository automation.
11
11
12
+
Scope: This README documents the `.github/` directory only. For project-wide overview and concepts, see the root [README.md](../README.md) (especially “Copying Copilot Customisations”).
13
+
12
14
### Copying Copilot Customisations
13
15
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.
16
+
The custom chat modes, instructions, and prompts are designed to be portable across repositories with the same directory layout. For general guidance and caveats, see the root [README: “Copying Copilot Customisations”](../README.md#7-copying-copilot-customisations).
15
17
16
-
Each of these files contains**HTML comments**that explain the funtionality, intent and any prompting methods used to reinforce instructions to the AI assistant. **Read the raw source code**to see this information.
18
+
Most files contain**HTML comments**inlined with additional context (functionality, intent, and prompting techniques). View the raw source to see these notes.
17
19
18
20
## GitHub Copilot Customisation
19
21
20
-
The [copilot-instructions.md](copilot-instructions.md) file contains the main instructions for Github Copilot.
22
+
The [copilot-instructions.md](copilot-instructions.md) file contains the main instructions for GitHub Copilot.
23
+
24
+
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.
- Branching & Workflow, Naming, Commit Conventions: see relevant sections in the same file
21
29
22
-
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:
30
+
See also:
23
31
- Project overview in [README.md](../README.md)
24
32
- Agent context in [AGENTS.md](../AGENTS.md)
25
33
26
34
### Custom Chat Modes
27
35
28
36
-[Custom Chat Modes](./chatmodes/README.md)
29
37
30
-
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.
38
+
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. Files live under `./chatmodes/` and use the `.chatmode.md` extension.
31
39
32
40
### Custom Instructions
33
41
34
42
-[Custom Instructions](./instructions/README.md)
35
43
36
-
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:
44
+
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 (SSOTs):
-`docs.instructions.md` (applies to all `**/*.md`)
@@ -47,7 +55,7 @@ Reusable prompts act like slash commands in Copilot Chat (e.g., `/write-adr`, `/
47
55
48
56
## GitHub Actions Customisation
49
57
50
-
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.
58
+
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. Prefer referencing SSOT anchors (e.g., Quality Policy) in validation jobs.
Copy file name to clipboardExpand all lines: .github/instructions/backend.instructions.md
+122Lines changed: 122 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,21 @@ Follow idiomatic practices for the chosen programming language and framework. Pr
15
15
-**Error Handling**: Implement robust error handling and logging to ensure system stability and ease of debugging.
16
16
-**Configuration Management**: Externalize configuration from code. Use environment variables or configuration files. Do not commit secrets to version control.
17
17
18
+
<aname="backend-architecture"></a>
19
+
## Architecture & Structure
20
+
21
+
Adopt a simple, layered architecture to keep boundaries clear and testable:
- Keep DTOs separate from domain models; map at edges.
24
+
- Inject dependencies through constructors. Avoid singletons and global state.
25
+
26
+
Language-specific notes:
27
+
- Spring Boot: Controllers (`@RestController`) → Services (`@Service`) → Repos (`@Repository`). Use packages by feature when helpful.
28
+
- Django: Views/ViewSets → Services (plain modules) → ORM Models/Managers. Keep fat models thin services as needed; avoid business logic in views.
29
+
- ASP.NET Core: Controllers → Services (DI) → Repositories (EF Core). Prefer interfaces for services/repositories for testability.
30
+
31
+
Testing guidance: unit-test services with fakes; integration-test controllers and repositories. See `.github/copilot-instructions.md#quality-policy` for coverage expectations.
32
+
18
33
## Language-Specific Guidelines
19
34
20
35
### Java
@@ -32,6 +47,18 @@ Follow idiomatic practices for the chosen programming language and framework. Pr
32
47
5.**REST APIs**: Use `@RestController` for creating RESTful services and DTOs (Data Transfer Objects) to decouple API contracts from domain models.
33
48
6.**Security**: Use Spring Security for authentication and authorization.
Copy file name to clipboardExpand all lines: AGENTS.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,7 @@ This file provides general instructions and context for all AI agents working in
13
13
- Use this file to understand the project’s goals, structure, and best practices.
14
14
- Reference configuration and documentation files for deeper context.
15
15
- For Copilot-specific instructions, see `.github/copilot-instructions.md`.
16
+
- Authoritative workflow rules (branching, commits, PRs, coverage policy) live in `.github/copilot-instructions.md` — link to it instead of duplicating.
16
17
- Other AI Agents should consider `.github/copilot-instructions.md` as informative, but not supersede their own custom instruction files, if present.
17
18
- It's critical to stop and alert the user if an AI finds conflicting instructions.
18
19
- The assistant must never use emoji's to decorate its responses to the user
@@ -24,4 +25,4 @@ This file provides general instructions and context for all AI agents working in
24
25
- Agent todo items MUST be maintained as a Markdown checkbox list only in `plans/TODO.md`, not in any other agent-specific file.
25
26
- Source code will be stored in the `src` directory.
26
27
27
-
This file may repeat some context from other docs to ensure agents have the information they need.
28
+
This file intentionally stays minimal; prefer linking to SSOT docs (see `README.md` Appendix: SSOT Source Map) over copying content.
0 commit comments