Skip to content

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

Merged
Malcolmnixon merged 3 commits intomainfrom
copilot/update-documentation-features
Mar 5, 2026
Merged

docs: reference Continuous Compliance strategy and add as a listed feature#53
Malcolmnixon merged 3 commits intomainfrom
copilot/update-documentation-features

Conversation

Copy link
Contributor

Copilot AI commented Mar 4, 2026

Adds explicit references to the DEMA Consulting Continuous Compliance strategy, which this template already implements but previously didn't call out by name. Changes are aligned with the pattern established in TemplateDotNetLibrary.

Description

  • README.md — Added Linting Enforcement, Continuous Compliance, SonarCloud Integration, and Requirements Traceability feature bullets; Continuous Compliance uses a reference-style link ([link-continuous-compliance]) with the definition appended to the existing link references at the bottom
  • docs/guide/guide.md — Added # Continuous Compliance as a top-level section (between Introduction and Installation) with a Key Practices subsection listing: Requirements Traceability, Linting Enforcement, Automated Audit Documentation, and CodeQL and SonarCloud

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code quality improvement

Pre-Submission Checklist

Before submitting this pull request, ensure you have completed the following:

Build and Test

  • Code builds successfully: dotnet build --configuration Release
  • All unit tests pass: dotnet test --configuration Release
  • Self-validation tests pass:
    dotnet run --project src/DemaConsulting.TemplateDotNetTool --configuration Release --framework net10.0
    --no-build -- --validate
  • Code produces zero warnings

Code Quality

  • Code formatting is correct: dotnet format --verify-no-changes
  • New code has appropriate XML documentation comments
  • Static analyzer warnings have been addressed

Quality Checks

Please run the following checks before submitting:

  • Spell checker passes: cspell "**/*.{md,cs}"
  • Markdown linter passes: markdownlint "**/*.md"
  • YAML linter passes: yamllint .

Testing

  • Added unit tests for new functionality
  • Updated existing tests if behavior changed
  • All tests follow the AAA (Arrange, Act, Assert) pattern
  • Test coverage is maintained or improved

Documentation

  • Updated README.md (if applicable)
  • Updated ARCHITECTURE.md (if applicable)
  • Added code examples for new features (if applicable)
  • Updated requirements.yaml (if applicable)

Additional Notes

Documentation-only change. No code, tests, or requirements modified. Structure and wording aligned with TemplateDotNetLibrary PR#29.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Review and update project documentation for features docs: reference Continuous Compliance strategy and add as a listed feature Mar 4, 2026
@Malcolmnixon
Copy link
Contributor

@copilot You may wish to look at the files of demaconsulting/TemplateDotNetLibrary#29 and make these changes match.

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Mar 4, 2026

@copilot You may wish to look at the files of demaconsulting/TemplateDotNetLibrary#29 and make these changes match.

Updated in c9a82f4 to match the TemplateDotNetLibrary/PR#29 pattern:

  • README.md: Changed to reference-style link ([link-continuous-compliance]), added Linting Enforcement, SonarCloud Integration, and Requirements Traceability feature bullets in the same order/style as the library PR
  • guide.md: Promoted Continuous Compliance to a top-level # Continuous Compliance section (out of Introduction) with the same Key Practices bullet points

@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 4, 2026 22:50
@Malcolmnixon Malcolmnixon merged commit 4ec5080 into main Mar 5, 2026
11 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/update-documentation-features branch March 5, 2026 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants