Skip to content

Commit 6b14e87

Browse files
committed
docs: resolve merge conflicts in README.md
- Fixed all 3-way merge conflict markers from recent governance updates merge - Preserved comprehensive content from both branches - Maintained clean document structure and SSOT references - README is now readable and properly formatted
1 parent b7458cf commit 6b14e87

File tree

1 file changed

+35
-26
lines changed

1 file changed

+35
-26
lines changed

README.md

Lines changed: 35 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,51 @@
22

33
Welcome! This repository is a GitHub Template created by Capgemini. It provides practical, portable, and useful examples of GitHub Copilot configuration for real-world projects.
44

5+
56
## Who this is for
67
- Developers and teams adopting AI-assisted development
7-
- Project and technical leads seeking practical best practices
8+
- Project and technical leads seeking guidance on best practices
89
- AI agents (including GitHub Copilot) needing repository context
910

1011
## What this repository provides
11-
- A ready-to-use template to bootstrap new projects (“Use this template” on GitHub)
12+
13+
This repository is intended to help teams adopt Copilot best practices, understand configuration options, and accelerate AI-powered development. It contains:
14+
1215
- Working Copilot configurations with examples:
13-
- [Chat modes](.github/chatmodes/README.md)
14-
- [Instructions](.github/instructions/README.md)
15-
- [Prompts](.github/prompts/README.md)
16-
- [GitHub configuration overview](.github/README.github.md)
16+
- Example [Chat modes](.github/chatmodes/README.md)
17+
- Example [Instructions](.github/instructions/README.md)
18+
- Example [Prompts](.github/prompts/README.md)
19+
- A GitHub Copilot [configuration overview](.github/README.github.md)
1720
- Clear documentation to understand, configure, and extend Copilot
21+
- Examples of prompting techniques for each custom configuration
22+
- A ready-to-use template to bootstrap new projects (“Use this template” on GitHub)
23+
- Comprehensive documentation and explanatory README.md files throughout the project.
1824

1925
## How to get started
26+
2027
1. Create a new repository using “Use this template” (or fork/clone).
2128
2. Review and adapt the example [chat modes](.github/chatmodes/README.md), [instructions](.github/instructions/README.md), and [prompts](.github/prompts/README.md).
2229
3. Read the project docs in [docs/README.md](docs/README.md).
2330

24-
## Key Features and Functionalities
31+
32+
<!-- Replace this paragraph with hints on finding information elsehwere in the repository -->
33+
34+
## Best Practices
35+
36+
Reuse and reference instructions files in your prompt files and chat modes to keep them clean and focused, and to avoid duplicating instructions.
37+
38+
- Keep instructions modular and single-purpose: one file = one responsibility (e.g., safety rules, tone, examples).
39+
- Use clear file names and a one-line summary at the top so contributors can find intent quickly.
40+
- Provide one short example and one minimal counterexample for each rule so users and agents see expected output.
41+
- Prefer imperative, action-oriented phrasing (“Do X”, “Avoid Y”) and concrete defaults (e.g., “Prefer 80-char lines”, “Use present tense”).
42+
- Surface usage patterns: when to reuse this file vs. override it; link to canonical files rather than duplicating content.
43+
- Add machine-friendly snippets or templates (prompts, code blocks, placeholders) that can be copy-pasted into prompts or chat modes.
44+
- Keep guidance short (1–3 sentences per rule) and add a “Why this matters” one-liner for context when necessary.
45+
- Version and change-log key updates so consumers know when behavior changed.
46+
- Include a brief test plan or example queries that validate the instruction works as intended.
47+
- Avoid embedding secrets or environment-specific data; reference where secure configs live (e.g., repo secrets, vault).
48+
- When in doubt, be explicit: busy users prefer exact commands/phrases to adapt rather than broad theory.
49+
2550

2651
### 1. Custom Chat Modes
2752

@@ -104,24 +129,8 @@ Types include: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
104129

105130
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.
106131

107-
## Best Practices
108-
109132
Reuse and reference instructions files in your prompt files and chat modes to keep them clean and focused, and to avoid duplicating instructions.
110133

111-
- Keep instructions modular and single-purpose: one file = one responsibility (e.g., safety rules, tone, examples).
112-
- Use clear file names and a one-line summary at the top so contributors can find intent quickly.
113-
- Lead with an explicit, human-readable “What to do” section: 1–3 concrete steps or a checklist people can follow immediately.
114-
- Provide one short example and one minimal counterexample for each rule so users and agents see expected output.
115-
- Prefer imperative, action-oriented phrasing (“Do X”, “Avoid Y”) and concrete defaults (e.g., “Prefer 80-char lines”, “Use present tense”).
116-
- Include required constraints up front (security, privacy, licensing, disallowed content) and where to raise exceptions.
117-
- Surface usage patterns: when to reuse this file vs. override it; link to canonical files rather than duplicating content.
118-
- Add machine-friendly snippets or templates (prompts, code blocks, placeholders) that can be copy-pasted into prompts or chat modes.
119-
- Keep guidance short (1–3 sentences per rule) and add a “Why this matters” one-liner for context when necessary.
120-
- Version and change-log key updates so consumers know when behavior changed.
121-
- Include a brief test plan or example queries that validate the instruction works as intended.
122-
- Avoid embedding secrets or environment-specific data; reference where secure configs live (e.g., repo secrets, vault).
123-
- When in doubt, be explicit: busy users prefer exact commands/phrases to adapt rather than broad theory.
124-
125134
### Adding New Features
126135

127136
When adding new chat modes, prompts, or instructions:
@@ -132,19 +141,19 @@ When adding new chat modes, prompts, or instructions:
132141
4. Update this master documentation
133142
5. Test with multiple scenarios before finalizing
134143

135-
136144
## Where to find more information
137145

138146
- See `AGENTS.md` for general AI agent instructions and project context
139147
- See `.github/copilot-instructions.md` for Copilot-specific rules and configuration
140148

141-
<!-- Replace this paragraph with hints on finding other relevant information about the repository -->
142149
### Copilot Customisation
143150

144151
You can find more about how to [customise and extend Github Copilot](https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions?tool=vscode), or how to customise Copilot behaviour in [Visual Studio Code](https://code.visualstudio.com/docs/copilot/customization/overview), and other IDEs such as [Jetbrains](https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions?tool=jetbrains), [Eclipse](https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions?tool=eclipse), and [XCode](https://docs.github.com/en/copilot/how-tos/configure-custom-instructions/add-repository-instructions?tool=xcode).
145152

153+
146154
You can find more examples of Copilot configuration in the [Awesome Copilot repository on Github.com](https://github.com/github/awesome-copilot/tree/main).
147155

156+
148157
# Document Reference Hierarchy
149158

150159
This diagram shows how documents reference each other across the repository, mapping the interconnections between configuration files, instructions, prompts, documentation, and plans.
@@ -309,4 +318,4 @@ Authoritative single sources of truth (SSOT) for key policies and templates. Pre
309318

310319
Notes:
311320
- Chat modes and prompts should reference these SSOT files. Avoid duplicating numeric thresholds, templates, or process steps in multiple places.
312-
- CI tasks (if added) should validate adherence to SSOT anchors where practical.
321+
- CI tasks (if added) should validate adherence to SSOT anchors where practical.

0 commit comments

Comments
 (0)