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
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,13 @@ This template demonstrates:
- **Multi-Runtime Support**: Targets .NET Standard 2.0, .NET 8, 9, and 10
- **MSTest V4**: Modern unit testing with MSTest framework version 4
- **Comprehensive CI/CD**: GitHub Actions workflows with quality checks and builds
- **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 @@ -76,3 +81,4 @@ By contributing to this project, you agree that your contributions will be licen
[link-quality]: https://sonarcloud.io/dashboard?id=demaconsulting_TemplateDotNetLibrary
[link-security]: https://sonarcloud.io/dashboard?id=demaconsulting_TemplateDotNetLibrary
[link-nuget]: https://www.nuget.org/packages/TemplateDotNetLibrary
[link-continuous-compliance]: https://github.com/demaconsulting/ContinuousCompliance
17 changes: 17 additions & 0 deletions docs/guide/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,20 @@ This user guide covers:
- Basic usage and examples
- API reference

# 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 library using the .NET CLI:
Expand Down Expand Up @@ -156,3 +170,6 @@ catch (ArgumentNullException ex)
Console.WriteLine("Name cannot be null");
}
```

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