diff --git a/.github/README.github.md b/.github/README.github.md index 4c2f5fe..c0ef174 100644 --- a/.github/README.github.md +++ b/.github/README.github.md @@ -60,3 +60,5 @@ References: - GitHub Actions docs: https://docs.github.com/actions - Copilot repository instructions: [copilot-instructions.md](./copilot-instructions.md) + + diff --git a/.github/chatmodes/CodeReviewer.chatmode.md b/.github/chatmodes/CodeReviewer.chatmode.md index d32c4b8..f1c2819 100644 --- a/.github/chatmodes/CodeReviewer.chatmode.md +++ b/.github/chatmodes/CodeReviewer.chatmode.md @@ -72,3 +72,5 @@ How to interpret: Apply these requirements in full; include at least one positiv + + diff --git a/.github/chatmodes/Developer.chatmode.md b/.github/chatmodes/Developer.chatmode.md index 5123e3b..993e0c8 100644 --- a/.github/chatmodes/Developer.chatmode.md +++ b/.github/chatmodes/Developer.chatmode.md @@ -423,3 +423,5 @@ PROMPTING TECHNIQUES: Specific examples that can be emulated. - Complex functions refactored into single-responsibility methods for clarity. + + diff --git a/.github/chatmodes/Documentation.chatmode.md b/.github/chatmodes/Documentation.chatmode.md index f1fd367..dca4148 100644 --- a/.github/chatmodes/Documentation.chatmode.md +++ b/.github/chatmodes/Documentation.chatmode.md @@ -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. + + diff --git a/.github/chatmodes/Planner.chatmode.md b/.github/chatmodes/Planner.chatmode.md index 7e67c99..e093479 100644 --- a/.github/chatmodes/Planner.chatmode.md +++ b/.github/chatmodes/Planner.chatmode.md @@ -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. + + diff --git a/.github/chatmodes/README.md b/.github/chatmodes/README.md index cc4da4c..8be4fe0 100644 --- a/.github/chatmodes/README.md +++ b/.github/chatmodes/README.md @@ -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. + + diff --git a/.github/chatmodes/Tester.chatmode.md b/.github/chatmodes/Tester.chatmode.md index cffe8db..b6229cc 100644 --- a/.github/chatmodes/Tester.chatmode.md +++ b/.github/chatmodes/Tester.chatmode.md @@ -126,3 +126,5 @@ How to interpret: Treat these as gates before merging; if unmet, iterate until s + + diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 6332f83..b86e83c 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -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. \ No newline at end of file +Refer to the main README.md for a full overview of repository goals and usage. + diff --git a/.github/instructions/README.md b/.github/instructions/README.md index b7d71c1..b8393f3 100644 --- a/.github/instructions/README.md +++ b/.github/instructions/README.md @@ -94,4 +94,5 @@ Bad: # Architecture --- - \ No newline at end of file + + diff --git a/.github/instructions/backend.instructions.md b/.github/instructions/backend.instructions.md index 6dd6b88..c4a2b84 100644 --- a/.github/instructions/backend.instructions.md +++ b/.github/instructions/backend.instructions.md @@ -239,3 +239,5 @@ using (logger.BeginScope(new Dictionary{{"correlationId", cid}}) References: - Branch/PR workflow and conventions: `.github/copilot-instructions.md`. - Coverage and critical-path rules: `.github/copilot-instructions.md#quality-policy`. + + diff --git a/.github/instructions/bdd-tests.instructions.md b/.github/instructions/bdd-tests.instructions.md index 289188d..1861e9f 100644 --- a/.github/instructions/bdd-tests.instructions.md +++ b/.github/instructions/bdd-tests.instructions.md @@ -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. + + diff --git a/.github/instructions/docs.instructions.md b/.github/instructions/docs.instructions.md index 1d0826b..75f1e84 100644 --- a/.github/instructions/docs.instructions.md +++ b/.github/instructions/docs.instructions.md @@ -177,3 +177,5 @@ flowchart TD H --> I[Plan maintenance cadence] ``` + + diff --git a/.github/instructions/frontend.instructions.md b/.github/instructions/frontend.instructions.md index fbd8fe0..f4b9ad1 100644 --- a/.github/instructions/frontend.instructions.md +++ b/.github/instructions/frontend.instructions.md @@ -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. + + diff --git a/.github/prompts/README.md b/.github/prompts/README.md index ca0fec9..1b473b5 100644 --- a/.github/prompts/README.md +++ b/.github/prompts/README.md @@ -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) \ No newline at end of file + - [Visual Studio Code custom prompt files](https://code.visualstudio.com/docs/copilot/customization/prompt-files) + diff --git a/.github/prompts/copilot-setup-check.prompt.md b/.github/prompts/copilot-setup-check.prompt.md index 4070443..b60ada1 100644 --- a/.github/prompts/copilot-setup-check.prompt.md +++ b/.github/prompts/copilot-setup-check.prompt.md @@ -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. + + diff --git a/.github/prompts/snippets/prd-success-metrics.snippet.md b/.github/prompts/snippets/prd-success-metrics.snippet.md index ea41889..0add4e1 100644 --- a/.github/prompts/snippets/prd-success-metrics.snippet.md +++ b/.github/prompts/snippets/prd-success-metrics.snippet.md @@ -37,3 +37,5 @@ Example metrics: - Datasource: Uptime monitoring (Pingdom) - Owner: SRE - Guardrails: Mean Time to Recovery ≤ 15m; No P0 incidents from this change + + diff --git a/.github/prompts/write-adr.prompt.md b/.github/prompts/write-adr.prompt.md index b124c21..afd2fb5 100644 --- a/.github/prompts/write-adr.prompt.md +++ b/.github/prompts/write-adr.prompt.md @@ -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 `. + + diff --git a/.github/prompts/write-docs.prompt.md b/.github/prompts/write-docs.prompt.md index 5fa8231..26e85ec 100644 --- a/.github/prompts/write-docs.prompt.md +++ b/.github/prompts/write-docs.prompt.md @@ -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. + + diff --git a/.github/prompts/write-ears-spec.prompt.md b/.github/prompts/write-ears-spec.prompt.md index a50f26f..fc8c536 100644 --- a/.github/prompts/write-ears-spec.prompt.md +++ b/.github/prompts/write-ears-spec.prompt.md @@ -129,3 +129,5 @@ While , if , then the **** shall ** diff --git a/.github/prompts/write-prd.prompt.md b/.github/prompts/write-prd.prompt.md index e77a366..6edc67f 100644 --- a/.github/prompts/write-prd.prompt.md +++ b/.github/prompts/write-prd.prompt.md @@ -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. + + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index def7e1b..1d3e223 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -21,3 +21,5 @@ ## Notes for Reviewers - Risks, trade-offs, or areas needing extra attention + + diff --git a/.github/workflows/docs-lint.yml b/.github/workflows/docs-lint.yml index 90f25ee..9cc5314 100644 --- a/.github/workflows/docs-lint.yml +++ b/.github/workflows/docs-lint.yml @@ -31,3 +31,5 @@ jobs: **/*.md env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + +# © Capgemini 2025 diff --git a/.github/workflows/policy-lint.yml b/.github/workflows/policy-lint.yml index 7e3c4f3..450f08a 100644 --- a/.github/workflows/policy-lint.yml +++ b/.github/workflows/policy-lint.yml @@ -20,3 +20,5 @@ jobs: - name: Run policy validator run: | node scripts/validate-policy.js + +# © Capgemini 2025 diff --git a/.gitignore b/.gitignore index 4f7263a..0f98b93 100644 --- a/.gitignore +++ b/.gitignore @@ -518,4 +518,6 @@ book/ # Repository-specific ignores # ========================== -# Add project-specific patterns below \ No newline at end of file +# Add project-specific patterns below + +# © Capgemini 2025 \ No newline at end of file diff --git a/.lychee.toml b/.lychee.toml index ab130c6..384da9c 100644 --- a/.lychee.toml +++ b/.lychee.toml @@ -20,3 +20,5 @@ accept_pattern = [ "^mailto:", "^#", ] + +# © Capgemini 2025 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9cfd1f6..9d216ac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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! + + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a357097 --- /dev/null +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md index 8b06374..86c146a 100644 --- a/README.md +++ b/README.md @@ -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. + + diff --git a/docs/ADRs/README.md b/docs/ADRs/README.md index 06d4cf9..21e1473 100644 --- a/docs/ADRs/README.md +++ b/docs/ADRs/README.md @@ -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) + + diff --git a/docs/ADRs/adr-template.md b/docs/ADRs/adr-template.md index 1d43737..f3c8dc9 100644 --- a/docs/ADRs/adr-template.md +++ b/docs/ADRs/adr-template.md @@ -59,3 +59,5 @@ superseded_by: "" - **REF-001**: [Related ADRs] - **REF-002**: [External documentation] - **REF-003**: [Standards or frameworks referenced] + + diff --git a/docs/EARS-specs/README.md b/docs/EARS-specs/README.md index f1c3263..2db600d 100644 --- a/docs/EARS-specs/README.md +++ b/docs/EARS-specs/README.md @@ -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. + + diff --git a/docs/PRDs/README.md b/docs/PRDs/README.md index 72347db..8f18ffd 100644 --- a/docs/PRDs/README.md +++ b/docs/PRDs/README.md @@ -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. + + diff --git a/docs/PRDs/prd-template.md b/docs/PRDs/prd-template.md index 3674418..d7c3ed3 100644 --- a/docs/PRDs/prd-template.md +++ b/docs/PRDs/prd-template.md @@ -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. + + diff --git a/docs/README.md b/docs/README.md index fc28524..d65abe3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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). + + diff --git a/docs/architecture/README.md b/docs/architecture/README.md index 64a6d6e..236f415 100644 --- a/docs/architecture/README.md +++ b/docs/architecture/README.md @@ -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) + + diff --git a/docs/design/README.md b/docs/design/README.md index fa7e24a..f6d62a9 100644 --- a/docs/design/README.md +++ b/docs/design/README.md @@ -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) + + diff --git a/docs/engineering/README.md b/docs/engineering/README.md index 1c3d06d..271e950 100644 --- a/docs/engineering/README.md +++ b/docs/engineering/README.md @@ -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) + + diff --git a/docs/engineering/code-review-guidelines.md b/docs/engineering/code-review-guidelines.md index 1173931..ef43403 100644 --- a/docs/engineering/code-review-guidelines.md +++ b/docs/engineering/code-review-guidelines.md @@ -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`. + + diff --git a/docs/engineering/pull-request-guidelines.md b/docs/engineering/pull-request-guidelines.md index 3c252e4..01a1a44 100644 --- a/docs/engineering/pull-request-guidelines.md +++ b/docs/engineering/pull-request-guidelines.md @@ -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. + + diff --git a/plans/README.md b/plans/README.md index fae21cc..f78e8af 100644 --- a/plans/README.md +++ b/plans/README.md @@ -23,3 +23,5 @@ Plans are used to: ## Archive Completed plans are moved from this directory into the `plans/archive` directory. + + diff --git a/plans/ROADMAP.md b/plans/ROADMAP.md index 77d62b7..c59f7bd 100644 --- a/plans/ROADMAP.md +++ b/plans/ROADMAP.md @@ -23,3 +23,5 @@ Example: `Q4 2025 — Platform auth hardening` ![In Progress](https://img.shield - Qx YYYY — Milestone name - Outcomes - Links to PRs/Docs + + diff --git a/plans/TODO.md b/plans/TODO.md index f0e21ed..23948dc 100644 --- a/plans/TODO.md +++ b/plans/TODO.md @@ -53,3 +53,5 @@ Review checklist mapping: Change log (for this file): - P1-06 completed by creating this structured TODO and seeding tasks. + + diff --git a/plans/archive/README.md b/plans/archive/README.md index 9db61d0..66af716 100644 --- a/plans/archive/README.md +++ b/plans/archive/README.md @@ -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. + + diff --git a/plans/archive/enhance-copilot-instructions-todos-plan.md b/plans/archive/enhance-copilot-instructions-todos-plan.md index 6f21600..6ec75d0 100644 --- a/plans/archive/enhance-copilot-instructions-todos-plan.md +++ b/plans/archive/enhance-copilot-instructions-todos-plan.md @@ -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 + + diff --git a/plans/examples/plan-small.md b/plans/examples/plan-small.md index 82e7fc2..63e0acc 100644 --- a/plans/examples/plan-small.md +++ b/plans/examples/plan-small.md @@ -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` + + diff --git a/plans/plan-template.md b/plans/plan-template.md index 78193b4..3b78849 100644 --- a/plans/plan-template.md +++ b/plans/plan-template.md @@ -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. + + diff --git a/recommendations.md b/recommendations.md index e2a6908..d670436 100644 --- a/recommendations.md +++ b/recommendations.md @@ -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... + + diff --git a/scripts/enforce-coverage.js b/scripts/enforce-coverage.js index a87346a..dfad3e3 100644 --- a/scripts/enforce-coverage.js +++ b/scripts/enforce-coverage.js @@ -97,3 +97,5 @@ function main() { if (require.main === module) { main(); } + +// © Capgemini 2025 diff --git a/scripts/validate-policy.js b/scripts/validate-policy.js index be6d768..0660a93 100644 --- a/scripts/validate-policy.js +++ b/scripts/validate-policy.js @@ -57,3 +57,5 @@ function main() { if (require.main === module) { main(); } + +// © Capgemini 2025