Skip to content

Sync AGENTS.md, agent files, standards, and lint scripts from TemplateDotNetTool#152

Merged
Malcolmnixon merged 1 commit intomainfrom
copilot/update-agents-and-lint-scripts
Apr 2, 2026
Merged

Sync AGENTS.md, agent files, standards, and lint scripts from TemplateDotNetTool#152
Malcolmnixon merged 1 commit intomainfrom
copilot/update-agents-and-lint-scripts

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 2, 2026

Pull Request

Description

Pulls updated agent and standards files from the TemplateDotNetTool template (commit 5c04d99) to keep this downstream repository aligned.

Updated files:

  • AGENTS.md — references new design-documentation.md standard
  • .github/agents/*.md — all five agent files refreshed from template
  • .github/standards/csharp-testing.md, reqstream-usage.md, reviewmark-usage.md, technical-documentation.md — updated from template

New files:

  • .github/standards/design-documentation.md — new standard defining docs/design/ layout, introduction.md requirements, and software structure diagram expectations

Supporting changes:

  • .cspell.yaml — added Qube to cover SonarQube references introduced by updated agent content

lint.sh / lint.bat were already identical to the template; no changes needed.

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

All lint checks pass. No source code or test changes — agent/standards files only.

- Update AGENTS.md with design-documentation.md standard reference
- Update all .github/agents/*.md agent definitions from template
- Add .github/standards/design-documentation.md (new standard)
- Update .github/standards/*.md with latest template content
- Add 'Qube' to .cspell.yaml for SonarQube terminology support

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
@Malcolmnixon Malcolmnixon marked this pull request as ready for review April 2, 2026 00:17
Copilot AI review requested due to automatic review settings April 2, 2026 00:17
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Syncs agent guidance and documentation standards from TemplateDotNetTool to keep this repository aligned with the upstream Continuous Compliance template.

Changes:

  • Updated AGENTS.md and refreshed all .github/agents/*.agent.md templates (report paths, placeholders, updated wording).
  • Updated standards docs and added a new design-documentation.md standard defining docs/design/ expectations.
  • Updated .cspell.yaml to accommodate new terminology introduced by the synced documentation.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
AGENTS.md Updates agent quick reference, standards list, and compliance/tooling guidance.
.github/agents/code-review.agent.md Refreshes formal review instructions and report filename template.
.github/agents/developer.agent.md Refreshes developer agent reporting template and placeholders.
.github/agents/implementation.agent.md Updates orchestration instructions and reporting placeholders.
.github/agents/quality.agent.md Replaces prior checklist text with a structured assessment/reporting template.
.github/agents/repo-consistency.agent.md Updates consistency agent reporting template and placeholders.
.github/standards/csharp-testing.md Minor wording/heading normalization (“anti-patterns”).
.github/standards/design-documentation.md New standard defining docs/design/ layout and required design document content.
.github/standards/reqstream-usage.md Updates requirements organization guidance and adds hierarchy/linking rules.
.github/standards/reviewmark-usage.md Updates ReviewMark pattern/examples and adds path conventions guidance.
.github/standards/technical-documentation.md Updates the recommended docs/ tree, including design/requirements folder conventions.
.cspell.yaml Adds Qube to the custom dictionary to cover SonarQube references.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Malcolmnixon Malcolmnixon merged commit 94cb070 into main Apr 2, 2026
19 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/update-agents-and-lint-scripts branch April 2, 2026 00:28
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.

3 participants