Skip to content

Merge latest improvements from the template#163

Merged
Malcolmnixon merged 6 commits into
mainfrom
updates-from-template
Apr 19, 2026
Merged

Merge latest improvements from the template#163
Malcolmnixon merged 6 commits into
mainfrom
updates-from-template

Conversation

@Malcolmnixon
Copy link
Copy Markdown
Member

Pull Request

Description

This PR merges in improvements from the template

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

Closes #

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 tests pass: dotnet test --configuration Release
  • Self-validation tests pass:
    dotnet run --project src/DemaConsulting.BuildMark --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:

  • 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

Malcolm Nixon added 2 commits April 19, 2026 16:28
- Agent files
- Lint/Fix/Build scripts
- Updating CI tools and build
Copilot AI review requested due to automatic review settings April 19, 2026 21:02
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

This PR merges template updates into the repo, expanding the Continuous Compliance toolchain (ReviewMark/Pandoc/WeasyPrint/FileAssert), shifting developer/CI scripts to PowerShell, and updating workflows + standards/docs accordingly.

Changes:

  • Replaces legacy lint.sh/lint.bat and build.sh/build.bat with PowerShell equivalents (lint.ps1, fix.ps1, build.ps1) and updates contributor/agent documentation.
  • Adds new OTS requirements files and configuration for additional tools (ReviewMark, Pandoc, WeasyPrint, FileAssert), and wires them into requirements includes.
  • Updates GitHub Actions workflows, tool manifests, and version capture configuration to support the expanded documentation/compliance pipeline.

Reviewed changes

Copilot reviewed 63 out of 63 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
requirements.yaml Includes additional OTS requirements files (ReviewMark/Pandoc/WeasyPrint/FileAssert).
pip-requirements.txt Adds yamlfix dependency for YAML auto-fix.
lint.sh Removes legacy bash lint driver script.
lint.ps1 Adds PowerShell-based lint script used by CI and contributors.
lint.bat Removes legacy batch lint driver script.
fix.ps1 Adds PowerShell auto-fix script (YAML/markdown/.NET formatting).
docs/user_guide/definition.yaml Removes stray whitespace line from Pandoc defaults YAML.
docs/reqstream/ots/weasyprint.yaml Adds OTS requirements for WeasyPrint behavior/evidence.
docs/reqstream/ots/versionmark.yaml Improves headings/structure for VersionMark OTS requirements.
docs/reqstream/ots/sonarmark.yaml Improves headings/structure for SonarMark OTS requirements.
docs/reqstream/ots/sarifmark.yaml Improves headings/structure for SarifMark OTS requirements.
docs/reqstream/ots/reviewmark.yaml Adds OTS requirements for ReviewMark behavior/evidence.
docs/reqstream/ots/reqstream.yaml Improves headings/structure for ReqStream OTS requirements.
docs/reqstream/ots/pandoc.yaml Adds OTS requirements for Pandoc behavior/evidence.
docs/reqstream/ots/mstest.yaml Improves headings/structure for MSTest OTS requirements.
docs/reqstream/ots/fileassert.yaml Adds OTS requirements for FileAssert behavior/evidence.
docs/reqstream/ots/buildmark.yaml Improves headings/structure for BuildMark OTS requirements.
docs/reqstream/build-mark/version/version.yaml Removes BOM from YAML header for consistency/tooling.
docs/reqstream/build-mark/version/version-semantic.yaml Removes BOM from YAML header for consistency/tooling.
docs/reqstream/build-mark/build-notes/build-notes.yaml Removes BOM from YAML header for consistency/tooling.
docs/reqstream/build-mark/build-mark.yaml Reflows long title: lines for lint/format consistency.
docs/code_review_report/title.txt Adds Pandoc metadata for review report document.
docs/code_review_report/introduction.md Adds authored intro content for review report collection.
docs/code_review_report/definition.yaml Adds Pandoc defaults for review report compilation.
docs/code_review_plan/title.txt Adds Pandoc metadata for review plan document.
docs/code_review_plan/introduction.md Adds authored intro content for review plan collection.
docs/code_review_plan/definition.yaml Adds Pandoc defaults for review plan compilation.
docs/code_quality/definition.yaml Removes stray whitespace line from Pandoc defaults YAML.
docs/build_notes/definition.yaml Removes stray whitespace line from Pandoc defaults YAML.
build.sh Removes legacy bash build driver script.
build.ps1 Adds PowerShell build driver script.
build.bat Removes legacy batch build driver script.
CONTRIBUTING.md Updates contributor workflow (fix/lint scripts, commit guidance, etc.).
CODE_OF_CONDUCT.md Updates to Contributor Covenant v2.1 text.
AGENTS.md Updates agent guidance, adds new lint-fix flow and reporting rules.
.yamlfix.toml Adds yamlfix configuration aligned to yamllint.
.versionmark.yaml Expands regexes and adds capture config for ReviewMark/FileAssert; updates BuildMark capture strategy.
.reviewmark.yaml Reworks review-set definitions and clarifies needs-review + evidence source documentation.
.markdownlint-cli2.yaml Disables markdownlint banner output.
.github/workflows/release.yaml Minor YAML block formatting adjustment for NuGet publish step.
.github/workflows/build_on_push.yaml Cleans up trigger formatting and comments.
.github/workflows/build.yaml Updates CI to use lint.ps1, expands doc build pipeline with new tools and artifacts.
.github/standards/technical-documentation.md Clarifies recursive subsystem structure conventions.
.github/standards/software-items.md Adds placeholder naming conventions and nested subsystem guidance.
.github/standards/reviewmark-usage.md Updates ReviewMark guidance (commands + nested subsystem patterns).
.github/standards/reqstream-usage.md Updates ReqStream guidance (nested subsystem + semantic ID language).
.github/standards/design-documentation.md Updates design docs guidance for nested subsystem structures.
.github/standards/csharp-testing.md Adjusts wording to remove vendor-specific phrasing.
.github/standards/csharp-language.md Adds reminder to run pwsh ./fix.ps1.
.github/standards/coding-principles.md Clarifies intent documentation expectations and structure adherence wording.
.github/codeql-config.yml Removes BOM from YAML header for consistency/tooling.
.github/agents/repo-consistency.agent.md Updates agent reporting requirement reference.
.github/agents/quality.agent.md Updates QA agent scope/rules and reporting template.
.github/agents/lint-fix.agent.md Adds new specialized agent definition for pre-PR lint cleanup.
.github/agents/implementation.agent.md Updates implementation state machine to a planning-first model and retry budgeting.
.github/agents/formal-review.agent.md Renames/clarifies formal review agent and reporting requirements.
.github/agents/developer.agent.md Updates developer agent workflow to include pre-flight + fix.ps1 usage + reporting.
.github/ISSUE_TEMPLATE/feature_request.yml Removes BOM from YAML header for consistency/tooling.
.github/ISSUE_TEMPLATE/config.yml Removes BOM from YAML header for consistency/tooling.
.github/ISSUE_TEMPLATE/bug_report.yml Removes BOM from YAML header for consistency/tooling.
.fileassert.yaml Adds FileAssert test definitions used by CI to validate generated docs.
.cspell.yaml Adds dictionary entries for FileAssert/yamlfix terms.
.config/dotnet-tools.json Adds BuildMark + FileAssert tools and reorders/extends tool manifest.

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

Comment thread .github/standards/reviewmark-usage.md
Comment thread build.ps1
Comment thread fix.ps1
Comment thread .github/standards/reviewmark-usage.md
Copilot AI review requested due to automatic review settings April 19, 2026 21:42
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 66 out of 66 changed files in this pull request and generated 3 comments.


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

Comment thread .github/workflows/build.yaml
Comment thread fix.ps1
Comment thread .github/workflows/build.yaml
Copilot AI review requested due to automatic review settings April 19, 2026 22:09
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 67 out of 67 changed files in this pull request and generated 2 comments.


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

Comment thread .versionmark.yaml
Comment thread AGENTS.md
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