Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/README.github.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,5 @@ References:
- GitHub Actions docs: https://docs.github.com/actions
- Copilot repository instructions: [copilot-instructions.md](./copilot-instructions.md)


<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/chatmodes/CodeReviewer.chatmode.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,5 @@ How to interpret: Apply these requirements in full; include at least one positiv
</CRITICAL_REQUIREMENT>



<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/chatmodes/Developer.chatmode.md
Original file line number Diff line number Diff line change
Expand Up @@ -423,3 +423,5 @@ PROMPTING TECHNIQUES: Specific examples that can be emulated.
- Complex functions refactored into single-responsibility methods for clarity.



<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/chatmodes/Documentation.chatmode.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,5 @@ Use saving and location guidance in `.github/instructions/docs.instructions.md`.
This chat mode does not restate the flow. Use the canonical source of truth (SSOT).
-->
- Reference: See `.github/instructions/docs.instructions.md#documentation-process-flow` for the canonical mermaid flow.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/chatmodes/Planner.chatmode.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,3 +191,5 @@ Practical tips
- Capture findings immediately in the plan and update the plan version/branch.
- When a loop uncovers large unknowns, convert the discovery into a separate spike with clear scope and exit criteria.
- Use the available Planner tools ('codebase', 'editFiles', 'fetch', 'get_file_contents', 'runCommands', 'search', 'usages') in combination; prefer small experiments over long guesses.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/chatmodes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,3 +193,5 @@ When updating a mode, increment its version and add a changelog entry explaining
---

If you're adding a new mode or editing an existing one, follow the repository's PR process: add the mode file under the appropriate folder, include examples and tests, and request review from the team listed in the contributing guidelines.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/chatmodes/Tester.chatmode.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,3 +126,5 @@ How to interpret: Treat these as gates before merging; if unmet, iterate until s




<!-- © Capgemini 2025 -->
3 changes: 2 additions & 1 deletion .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -435,4 +435,5 @@ The `.github` directory contains several subdirectories and files that organize

- `workflows/`: Intended for GitHub Actions workflow files, which automate CI/CD and other repository tasks. (Currently empty, but will be expanded.)

Refer to the main README.md for a full overview of repository goals and usage.
Refer to the main README.md for a full overview of repository goals and usage.
<!-- © Capgemini 2025 -->
3 changes: 2 additions & 1 deletion .github/instructions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,5 @@ Bad: # Architecture
---




<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/instructions/backend.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,3 +239,5 @@ using (logger.BeginScope(new Dictionary<string, object>{{"correlationId", cid}})
References:
- Branch/PR workflow and conventions: `.github/copilot-instructions.md`.
- Coverage and critical-path rules: `.github/copilot-instructions.md#quality-policy`.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/instructions/bdd-tests.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,3 +138,5 @@ SECTION PURPOSE: Encourage living docs and CI-ready behavior.
4. Wire into CI to run on PRs and gate merges on failures.
5. Tag scenarios appropriately and configure CI to run fast suites on PRs (e.g., `@smoke`) and full suites nightly.
6. Keep step definitions DRY; refactor when duplication creeps in.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/instructions/docs.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,3 +177,5 @@ flowchart TD
H --> I[Plan maintenance cadence]
```


<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/instructions/frontend.instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,5 @@ PROMPTING: XML block for machine-checkable rules.
- Include accessibility checks (labels, keyboard nav, focus order) in reviews.
- Avoid `any`; if unavoidable, annotate with a TODO and reason.
</PROCESS_REQUIREMENTS>

<!-- © Capgemini 2025 -->
3 changes: 2 additions & 1 deletion .github/prompts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,5 @@ Within a prompt file, you can reference variables by using the `${variableName}`

## Official Docs

- [Visual Studio Code custom prompt files](https://code.visualstudio.com/docs/copilot/customization/prompt-files)
- [Visual Studio Code custom prompt files](https://code.visualstudio.com/docs/copilot/customization/prompt-files)
<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/prompts/copilot-setup-check.prompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,3 +160,5 @@ This evaluation will assess:
- Include rationale for all major recommendations

Execute this evaluation systematically and provide a comprehensive report that enables the repository maintainers to optimize their Copilot and AI agent configuration effectively.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/prompts/snippets/prd-success-metrics.snippet.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,5 @@ Example metrics:
- Datasource: Uptime monitoring (Pingdom)
- Owner: SRE
- Guardrails: Mean Time to Recovery ≤ 15m; No P0 incidents from this change

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/prompts/write-adr.prompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,5 @@ The documentation file must follow the template specified in `docs/ADRs/adr-temp

- If not already on a feature branch, create `adr/[brief-title-slug]` before saving.
- Commit message should follow Conventional Commits, e.g.: `docs: add ADR NNNN <Decision Title>`.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/prompts/write-docs.prompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,5 @@ If inputs are missing/ambiguous/conflicting, follow the input collection and val
- If the user requests documentation for a specific audience (e.g., end-users, stakeholders), tailor the content and language to suit that audience.

If you can clearly identify any inputs from the conversation immediately prior to this, check with the user that you have understood those inputs correctly. Else, if you can't clearly identify any inputs from the conversation immediately prior to this, prompt the user for each input. Map their responses to the documentation inputs: purpose and scope, target audience, key features and functionalities, and existing documentation.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/prompts/write-ears-spec.prompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,3 +129,5 @@ While <pre-condition>, if <trigger>, then the **<system-name>** shall **<system-
```

Tell the user: Unwanted behavior requirements specify how the system should respond to undesired events or states.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/prompts/write-prd.prompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,5 @@ Where helpful, add short implementation notes and suggested acceptance tests tha
- Save under `docs/PRDs/` using `prd-[brief-title-slug].md` unless an existing convention overrides it.
- Do not publish without confirming with the requester or PRD owner.
</CRITICAL_REQUIREMENT>

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@
## Notes for Reviewers

- Risks, trade-offs, or areas needing extra attention

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions .github/workflows/docs-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,5 @@ jobs:
**/*.md
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

# © Capgemini 2025
2 changes: 2 additions & 0 deletions .github/workflows/policy-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ jobs:
- name: Run policy validator
run: |
node scripts/validate-policy.js

# © Capgemini 2025
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -518,4 +518,6 @@ book/

# Repository-specific ignores
# ==========================
# Add project-specific patterns below
# Add project-specific patterns below

# © Capgemini 2025
2 changes: 2 additions & 0 deletions .lychee.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ accept_pattern = [
"^mailto:",
"^#",
]

# © Capgemini 2025
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,3 +288,5 @@ If you have questions about contributing, please:
3. Open an issue with your question

Thank you for helping make this repository a valuable educational resource!

<!-- © Capgemini 2025 -->
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Capgemini

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,3 +320,5 @@ Notes:

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

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions docs/ADRs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ ADRs document significant architectural decisions along with their context and c
Add links to ADRs in sequential order using the naming convention `adr-NNNN-title-slug.md`.

- [ADR 0001 Brief Title Slug](adr-0001-brief-title-slug.md)

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions docs/ADRs/adr-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,5 @@ superseded_by: ""
- **REF-001**: [Related ADRs]
- **REF-002**: [External documentation]
- **REF-003**: [Standards or frameworks referenced]

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions docs/EARS-specs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
This directory contains requirements written using the EARS (Easy Approach to Requirements Syntax) style. EARS provides a simple, structured way to express requirements using patterns such as Ubiquitous, Event-Driven, State-Driven, Unwanted Behavior, and Optional features.

Organize specs by product or component. Include traceability links to PRDs and tests where possible.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions docs/PRDs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ PRDs define product goals, scope, stakeholders, and success criteria. Use this d
## Archive

Completed PRDs are moved from this directory into the `docs/PRDs/archive` directory.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions docs/PRDs/prd-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,5 @@ List all main stakeholders, their roles, and relevant contact or notes. Add/remo
### 13. References & Related Documents

- Link to wireframes, mockups, technical specs, research, or other supporting docs.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@ There are three examples of how to influence and use AI to write documentation i
- [Custom chat modes](../.github/chatmodes/custom-mode.chatmode.md) — Preset conversational configurations that shape Copilot’s behavior and tone during interactive sessions and document generation.
- [Instructions](../.github/instructions/docs.instructions.md) — Repository-specific rules and constraints (coding standards, workflow, style) that the AI must follow when producing content.
- [Prompts](../.github/prompts/write-docs.prompt.md) — Reusable prompt templates for generating consistent artifacts (e.g., ADRs, docs, PRDs). See also [write-adr.prompt.md](../.github/prompts/write-adr.prompt.md) and [write-prd.prompt.md](../.github/prompts/write-prd.prompt.md).

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions docs/architecture/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,5 @@ Architecture docs that are specific to this repository should live here. Organiz
### External Architecture documents

- (Add links to external architecture documents or diagrams)

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions docs/design/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,5 @@ Design docs that affect this repository's code should live here. If your organiz
### External Design documents

- (Add links to external design docs or diagrams hosted outside the repo)

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions docs/engineering/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@ This directory contains engineering processes and standards (e.g., code reviews,

- [Code Review Guidelines](code-review-guidelines.md)
- [Pull Request Guidelines](pull-request-guidelines.md)

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions docs/engineering/code-review-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,5 @@ How to use:
- Branch/PR workflow, naming, commit conventions, PR size and review SLA: see `.github/copilot-instructions.md`.
- Coverage targets and hot/error/security path requirements: see `.github/copilot-instructions.md#quality-policy`.
- Pull request author checklist: see `docs/engineering/pull-request-guidelines.md`.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions docs/engineering/pull-request-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@ N.B. This file is written for humans and AI. GitHub Copilot consumes it via [VS
- **Assign Reviewers**: Assign at least one reviewer to your PR.
- **Address Feedback**: Respond to all comments and address the feedback.
- **Merge**: Once the PR is approved, it can be merged into the main branch. Use "Squash and Merge" to keep the commit history clean.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions plans/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,5 @@ Plans are used to:
## Archive

Completed plans are moved from this directory into the `plans/archive` directory.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions plans/ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,5 @@ Example: `Q4 2025 — Platform auth hardening` ![In Progress](https://img.shield
- Qx YYYY — Milestone name
- Outcomes
- Links to PRs/Docs

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions plans/TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,5 @@ Review checklist mapping:
Change log (for this file):

- P1-06 completed by creating this structured TODO and seeding tasks.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions plans/archive/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Archived Plans Directory

This directory stores completed or superseded plans for historical reference. Move a plan here after it has been approved, executed, and superseded by newer plans.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions plans/archive/enhance-copilot-instructions-todos-plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,3 +310,5 @@ The implementation will preserve the existing file structure and formatting whil
- [x] Estimates present and normalized to hours
- [x] At least one test/validation approach is defined
- [x] Security & compliance items are noted

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions plans/examples/plan-small.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,5 @@ Purpose: Demonstrate a lightweight planning artifact using complexity-only estim

- Quality & Coverage Policy: `.github/copilot-instructions.md#quality-policy`
- Template: `plans/plan-template.md`

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions plans/plan-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,3 +195,5 @@ Checklist before marking plan as ready for review:
- [ ] Security & compliance items are noted.

If you want, I can also generate a filled example plan from this template for a sample project. Specify the project details and I'll produce it.

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions recommendations.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,3 +238,5 @@ Principles:
Primary issues: Duplication (documentation workflow, coverage rules, branch process), conflicting numeric policies (coverage, estimation), and sparse backend / BDD guidance. Remedy through an authoritative source map, lean refactors that replace repetition with references, and a central quality policy. After changes, maintenance cost and drift risk decrease; onboarding clarity increases.

...existing code...

<!-- © Capgemini 2025 -->
2 changes: 2 additions & 0 deletions scripts/enforce-coverage.js
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,5 @@ function main() {
if (require.main === module) {
main();
}

// © Capgemini 2025
2 changes: 2 additions & 0 deletions scripts/validate-policy.js
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,5 @@ function main() {
if (require.main === module) {
main();
}

// © Capgemini 2025