Skip to content

Commit c9a82f4

Browse files
CopilotMalcolmnixon
andcommitted
Align docs with TemplateDotNetLibrary pattern for Continuous Compliance
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
1 parent 9251074 commit c9a82f4

File tree

2 files changed

+18
-7
lines changed

2 files changed

+18
-7
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,13 @@ This template demonstrates:
2222
- **Multi-Runtime Support**: Targets .NET 8, 9, and 10
2323
- **Comprehensive CI/CD**: GitHub Actions workflows with quality checks, builds, and
2424
integration tests
25+
- **Linting Enforcement**: markdownlint, cspell, and yamllint enforced on every CI run
26+
- **Continuous Compliance**: Compliance evidence generated automatically on every CI run, following
27+
the [Continuous Compliance][link-continuous-compliance] methodology
28+
- **SonarCloud Integration**: Quality gate and security analysis on every build
2529
- **Documentation Generation**: Automated build notes, user guide, code quality reports,
2630
requirements, justifications, and trace matrix
27-
- **Continuous Compliance**: Automated, evidence-based quality enforcement following the
28-
[DEMA Consulting Continuous Compliance strategy](https://github.com/demaconsulting/ContinuousCompliance)
31+
- **Requirements Traceability**: Requirements linked to passing tests with auto-generated trace matrix
2932

3033
## Installation
3134

@@ -134,3 +137,4 @@ By contributing to this project, you agree that your contributions will be licen
134137
[link-security]: https://sonarcloud.io/dashboard?id=demaconsulting_TemplateDotNetTool
135138
[link-nuget]: https://www.nuget.org/packages/DemaConsulting.TemplateDotNetTool
136139
[link-guide]: https://github.com/demaconsulting/TemplateDotNetTool/blob/main/docs/guide/guide.md
140+
[link-continuous-compliance]: https://github.com/demaconsulting/ContinuousCompliance

docs/guide/guide.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,19 @@ This user guide covers:
1414
- Command-line options reference
1515
- Practical examples for various scenarios
1616

17-
## Continuous Compliance
17+
# Continuous Compliance
1818

19-
This project follows the [DEMA Consulting Continuous Compliance][continuous-compliance]
20-
strategy — automated, evidence-based quality enforcement on every CI/CD run. Each build
21-
automatically lints documentation, verifies all requirements are covered by passing tests,
22-
runs code quality gates, records tool versions, and generates a complete audit trail.
19+
This template follows the [Continuous Compliance][continuous-compliance] methodology, which ensures
20+
compliance evidence is generated automatically on every CI run.
21+
22+
## Key Practices
23+
24+
- **Requirements Traceability**: Every requirement is linked to passing tests, and a trace matrix is
25+
auto-generated on each release
26+
- **Linting Enforcement**: markdownlint, cspell, and yamllint are enforced before any build proceeds
27+
- **Automated Audit Documentation**: Each release ships with generated requirements, justifications,
28+
trace matrix, and quality reports
29+
- **CodeQL and SonarCloud**: Security and quality analysis runs on every build
2330

2431
# Installation
2532

0 commit comments

Comments
 (0)