Skip to content

docs: sync with TemplateDotNetLibrary — add Continuous Compliance references#113

Merged
Malcolmnixon merged 2 commits intomainfrom
copilot/update-repository-from-template
Mar 5, 2026
Merged

docs: sync with TemplateDotNetLibrary — add Continuous Compliance references#113
Malcolmnixon merged 2 commits intomainfrom
copilot/update-repository-from-template

Conversation

Copy link
Contributor

Copilot AI commented Mar 5, 2026

Pull Request

Description

Syncs with TemplateDotNetLibrary commit #29, which added Continuous Compliance methodology references to the README and user guide.

  • README.md: Added 🔒 Continuous Compliance feature bullet with absolute URL to ContinuousCompliance
  • docs/guide/guide.md: Added # Continuous Compliance section (between Introduction and Prerequisites) covering the four key practices — Requirements Traceability, Linting Enforcement, Automated Audit Documentation, and CodeQL/SonarCloud; added [continuous-compliance] reference link at document end

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

Related Issues

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
  • 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 or test modifications.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

…ME and user guide

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Update repository from template and check commits docs: sync with TemplateDotNetLibrary — add Continuous Compliance references Mar 5, 2026
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