Skip to content

docs: reference Continuous Compliance strategy and add as a listed feature #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Malcolmnixon merged 3 commits into from
Mar 5, 2026
+23 −0
Merged

docs: reference Continuous Compliance strategy and add as a listed feature #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8360994
Initial plan
Copilot Mar 4, 2026
9251074
Add Continuous Compliance references to README and user guide
Copilot Mar 4, 2026
c9a82f4
Align docs with TemplateDotNetLibrary pattern for Continuous Compliance
Copilot Mar 4, 2026
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,13 @@ This template demonstrates:
- **Multi-Runtime Support**: Targets .NET 8, 9, and 10
- **Comprehensive CI/CD**: GitHub Actions workflows with quality checks, builds, and
integration tests
- **Linting Enforcement**: markdownlint, cspell, and yamllint enforced on every CI run
- **Continuous Compliance**: Compliance evidence generated automatically on every CI run, following
the [Continuous Compliance][link-continuous-compliance] methodology
- **SonarCloud Integration**: Quality gate and security analysis on every build
- **Documentation Generation**: Automated build notes, user guide, code quality reports,
requirements, justifications, and trace matrix
- **Requirements Traceability**: Requirements linked to passing tests with auto-generated trace matrix

## Installation

Expand Down Expand Up @@ -132,3 +137,4 @@ By contributing to this project, you agree that your contributions will be licen
[link-security]: https://sonarcloud.io/dashboard?id=demaconsulting_TemplateDotNetTool
[link-nuget]: https://www.nuget.org/packages/DemaConsulting.TemplateDotNetTool
[link-guide]: https://github.com/demaconsulting/TemplateDotNetTool/blob/main/docs/guide/guide.md
[link-continuous-compliance]: https://github.com/demaconsulting/ContinuousCompliance
17 changes: 17 additions & 0 deletions docs/guide/guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,20 @@ This user guide covers:
- Command-line options reference
- Practical examples for various scenarios

# Continuous Compliance

This template follows the [Continuous Compliance][continuous-compliance] methodology, which ensures
compliance evidence is generated automatically on every CI run.

## Key Practices

- **Requirements Traceability**: Every requirement is linked to passing tests, and a trace matrix is
auto-generated on each release
- **Linting Enforcement**: markdownlint, cspell, and yamllint are enforced before any build proceeds
- **Automated Audit Documentation**: Each release ships with generated requirements, justifications,
trace matrix, and quality reports
- **CodeQL and SonarCloud**: Security and quality analysis runs on every build

# Installation

Install the tool globally using the .NET CLI:
Expand Down Expand Up @@ -143,3 +157,6 @@ templatetool --validate --results validation-results.trx
```bash
templatetool --silent --log tool-output.log
```

<!-- Link References -->
[continuous-compliance]: https://github.com/demaconsulting/ContinuousCompliance