Skip to content

chore: sync AGENTS.md, agent definitions, standards, and lint scripts from TemplateDotNetTool#68

Merged
Malcolmnixon merged 2 commits intomainfrom
copilot/copy-updated-files-from-template
Apr 11, 2026
Merged

chore: sync AGENTS.md, agent definitions, standards, and lint scripts from TemplateDotNetTool#68
Malcolmnixon merged 2 commits intomainfrom
copilot/copy-updated-files-from-template

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 11, 2026

Binary-copy updated template files from TemplateDotNetTool into this repository.

Description

  • AGENTS.md — Added references to two new standards files; updated existing descriptions; fixed trailing whitespace
  • .github/standards/coding-principles.md (new) — Universal literate coding principles, architecture patterns, and quality gates
  • .github/standards/testing-principles.md (new) — Universal test dependency boundaries and AAA pattern requirements
  • .github/standards/*.md (7 existing) — Added YAML frontmatter (name, description, globs); added Required Standards cross-reference sections linking to the new principles files; minor content refinements aligned to template
  • lint.sh / lint.bat — Added full dotnet linting section (dotnet tool restore + reqstream/reviewmark lint) and dotnet formatting section (dotnet restore + dotnet format --verify-no-changes --no-restore); previously only ran dotnet format with no tool/package restore. dotnet versionmark --lint is excluded because VersionMark is built in this repository and is not available as an installed tool during linting.

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.VersionMark --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

No functional code changes. All modifications are to agent guidance, standards documentation, and lint tooling scripts.

@Malcolmnixon Malcolmnixon marked this pull request as ready for review April 11, 2026 17:19
Copilot AI review requested due to automatic review settings April 11, 2026 17:19
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, standards documentation, and lint tooling with the upstream TemplateDotNetTool template to keep this repo’s compliance/quality workflow aligned and repeatable.

Changes:

  • Adds two new universal standards documents (coding-principles.md, testing-principles.md) and updates existing standards with YAML frontmatter + cross-references.
  • Updates AGENTS.md to reference the new standards and refreshes guidance text.
  • Expands lint.sh / lint.bat to restore dotnet tools/packages and run reqstream/versionmark/reviewmark lint before dotnet format.

Reviewed changes

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

Show a summary per file
File Description
lint.sh Adds npm env var and expands linting to include dotnet tool restore + reqstream/versionmark/reviewmark lint + restore + format verification.
lint.bat Windows equivalent of the expanded linting/formatting pipeline.
AGENTS.md Updates standards list and minor formatting/placeholder tweaks.
.github/standards/coding-principles.md New universal coding principles/quality gates standard.
.github/standards/testing-principles.md New universal testing principles/dependency boundaries standard.
.github/standards/csharp-language.md Adds frontmatter and refactors content to reference universal coding principles.
.github/standards/csharp-testing.md Adds frontmatter + “Required Standards” references; trims requirements-coverage section.
.github/standards/design-documentation.md Adds frontmatter + “Required Standards”; clarifies design scope excludes test projects.
.github/standards/reqstream-usage.md Adds frontmatter + “Required Standards”; clarifies downward-only linking language.
.github/standards/reviewmark-usage.md Adds frontmatter + “Required Standards” reference.
.github/standards/software-items.md Adds frontmatter and clarifies subsystem/unit definitions.
.github/standards/technical-documentation.md Adds frontmatter and adds guidance about external-only references sections.

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

@Malcolmnixon
Copy link
Copy Markdown
Member

@copilot Please remove the versionmark linting from lint.bat/lint.sh because this is the repository that builds versionmark so it isn't available at the time of linting.

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 11, 2026

@copilot Please remove the versionmark linting from lint.bat/lint.sh because this is the repository that builds versionmark so it isn't available at the time of linting.

Done — removed dotnet versionmark --lint from both lint.sh and lint.bat in commit 97b6ca6.

Copilot AI and others added 2 commits April 11, 2026 16:07
Agent-Logs-Url: https://github.com/demaconsulting/VersionMark/sessions/837346b4-cd34-4b9f-a390-16e986a21059

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Agent-Logs-Url: https://github.com/demaconsulting/VersionMark/sessions/1ce22cf1-c478-4af9-b4db-4f905fd5ee7b

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 11, 2026 20:07
@Malcolmnixon Malcolmnixon force-pushed the copilot/copy-updated-files-from-template branch from 97b6ca6 to 0c1c07f Compare April 11, 2026 20:07
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

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.


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

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