Skip to content

Sync template files from TemplateDotNetLibrary#34

Merged
Malcolmnixon merged 1 commit into
mainfrom
copilot/copy-updated-docs-and-scripts
Apr 12, 2026
Merged

Sync template files from TemplateDotNetLibrary#34
Malcolmnixon merged 1 commit into
mainfrom
copilot/copy-updated-docs-and-scripts

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 12, 2026

Binary-copy updated agent, standards, and lint script files from the upstream TemplateDotNetLibrary template.

Changes

New Standards Files

  • coding-principles.md — Universal coding principles: literate programming, architecture patterns, anti-patterns
  • testing-principles.md — Universal testing principles: hierarchy boundaries (System/Subsystem/Unit), AAA pattern

Updated Standards Files

  • csharp-language.md — Now requires coding-principles.md as a prerequisite standard
  • csharp-testing.md — Now requires testing-principles.md + csharp-language.md
  • design-documentation.md, reqstream-usage.md, reviewmark-usage.md, software-items.md, technical-documentation.md — Minor additions and clarifications from template evolution

Updated Agent Files

  • All .github/agents/*.md refreshed; quality.agent.md gains expanded assessment template sections

Updated AGENTS.md

  • References new coding-principles.md and testing-principles.md in the standards application section

Updated Lint Scripts

  • lint.sh / lint.bat — Restructured with cleaner per-section skip logic and consistent error handling

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
  • 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:

  • All linters pass: ./lint.sh (Unix/macOS) or cmd /c lint.bat / ./lint.bat (Windows)

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 — documentation and tooling files only.

Agent-Logs-Url: https://github.com/demaconsulting/NuGetCaching/sessions/a3ea4048-86be-41f6-b97e-139d6dfe5474

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
@Malcolmnixon Malcolmnixon marked this pull request as ready for review April 12, 2026 02:07
Copilot AI review requested due to automatic review settings April 12, 2026 02: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

Syncs this repository’s agent guidance, standards documentation, and linting scripts with the upstream TemplateDotNetLibrary template to keep Continuous Compliance workflows consistent.

Changes:

  • Added new universal standards docs for coding and testing principles.
  • Updated multiple existing standards/agent docs with frontmatter, prerequisites, and clarifications.
  • Refactored lint.sh / lint.bat to include dotnet tool linting (ReqStream/VersionMark/ReviewMark) and improved section skip logic.

Reviewed changes

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

Show a summary per file
File Description
lint.sh Adds Puppeteer download skip, restores dotnet tools, runs ReqStream/VersionMark/ReviewMark linting, and uses dotnet format --no-restore.
lint.bat Mirrors the lint script restructuring on Windows, including dotnet tool restore and additional linting tools.
AGENTS.md Updates standards list to include new principles docs and refreshes minor formatting/placeholders.
.github/standards/coding-principles.md New universal coding principles and quality gates document.
.github/standards/testing-principles.md New universal testing principles document (dependency boundaries + AAA requirements).
.github/standards/csharp-language.md Adds frontmatter and makes coding principles a prerequisite; streamlines content.
.github/standards/csharp-testing.md Adds frontmatter and prerequisite standards; keeps MSTest guidance and anti-patterns.
.github/standards/design-documentation.md Adds frontmatter, prerequisite standards, and clarifies scope exclusions for tests.
.github/standards/reqstream-usage.md Adds frontmatter/prereqs and clarifies downward-only linking language.
.github/standards/reviewmark-usage.md Adds frontmatter and prerequisite standards.
.github/standards/software-items.md Adds frontmatter and clarifies subsystem/unit definitions.
.github/standards/technical-documentation.md Adds frontmatter and introduces guidance for references sections.
.github/agents/quality.agent.md Expands the assessment template criteria and relocates the Result-field rules.

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

Comment thread .github/standards/technical-documentation.md
@Malcolmnixon Malcolmnixon merged commit 49fe8fe into main Apr 12, 2026
10 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/copy-updated-docs-and-scripts branch April 12, 2026 02:20
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