Skip to content

docs: add Tag Filtering feature to guide and reference ContinuousCompliance strategy#121

Merged
Malcolmnixon merged 3 commits intomainfrom
copilot/review-documentation-updates
Mar 5, 2026
Merged

docs: add Tag Filtering feature to guide and reference ContinuousCompliance strategy#121
Malcolmnixon merged 3 commits intomainfrom
copilot/review-documentation-updates

Conversation

Copy link
Contributor

Copilot AI commented Mar 4, 2026

Pull Request

Description

Addresses two documentation gaps: Tag Filtering was missing from the guide's Key Features summary (present in README but not guide.md), and neither doc referenced the Continuous Compliance strategy that ReqStream is a component of.

Changes

  • README.md — Added 🔒 Continuous Compliance as a feature bullet in the Features list (using [link-continuous-compliance] ref); removed inline Overview sentence
  • docs/guide/guide.md — Added Tag Filtering to the Key Features list; replaced inline Use Cases mention with a dedicated # Continuous Compliance section containing a ## Key Practices subsection; added <!-- Link References --> comment before the link section

The ContinuousCompliance placement and structure aligns with the pattern established in TemplateDotNetTool PR #53.

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
  • Self-validation tests pass:
    dotnet run --project src/DemaConsulting.ReqStream --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 or test modifications.


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

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI changed the title [WIP] Review project documentation for feature updates docs: add Tag Filtering feature to guide and reference ContinuousCompliance strategy Mar 4, 2026
@Malcolmnixon
Copy link
Contributor

@copilot Consider aligning with the changes from demaconsulting/TemplateDotNetTool#53

…ttern

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

Copilot AI commented Mar 4, 2026

@copilot Consider aligning with the changes from demaconsulting/TemplateDotNetTool#53

Done in c5ee93d. Aligned with TemplateDotNetTool PR #53:

  • README.md: Moved ContinuousCompliance from the Overview paragraph to a 🔒 **Continuous Compliance** feature bullet; updated link ref to [link-continuous-compliance]
  • docs/guide/guide.md: Replaced the inline mention with a dedicated # Continuous Compliance section (with ## Key Practices subsection) between the Introduction and Prerequisites sections; added <!-- Link References --> comment before the link section

@Malcolmnixon Malcolmnixon marked this pull request as ready for review March 4, 2026 22:57
@Malcolmnixon Malcolmnixon merged commit 4add437 into main Mar 5, 2026
11 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/review-documentation-updates 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