Repo update#144
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR modernizes the repo’s Continuous Compliance tooling and documentation pipeline by standardizing on PowerShell scripts, expanding OTS requirements, and adding a full User Guide document collection.
Changes:
- Replaces bash/batch build & lint entrypoints with
build.ps1,lint.ps1, andfix.ps1(plus YAML auto-fix config). - Updates ReqStream requirements structure (including OTS items for Pandoc/WeasyPrint/FileAssert and UTF-8 XML declaration requirements).
- Expands docs pipeline outputs (User Guide) and updates ReviewMark/VersionMark/workflows to align.
Reviewed changes
Copilot reviewed 61 out of 63 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| spdx-workflow.yaml | Removes an extra blank line in workflow header. |
| requirements.yaml | Updates ReqStream include list (drops old files, adds pandoc/weasyprint/fileassert). |
| pip-requirements.txt | Adds yamlfix to Python tooling requirements. |
| lint.sh | Removes legacy bash lint script (replaced by lint.ps1). |
| lint.ps1 | Adds unified PowerShell lint script used by CI. |
| lint.bat | Removes legacy batch lint script (replaced by lint.ps1). |
| fix.ps1 | Adds PowerShell auto-fix script (yamlfix/markdownlint/dotnet format). |
| docs/user_guide/title.txt | Adds Pandoc front-matter for the User Guide. |
| docs/user_guide/introduction.md | Adds a comprehensive User Guide content section. |
| docs/user_guide/definition.yaml | Updates Pandoc defaults to point at the new user guide folder/files. |
| docs/reqstream/test-results-library/test-results-library.yaml | Refines system-level requirement IDs/titles and justifications. |
| docs/reqstream/test-results-library/io/trx-serializer.yaml | Adds TRX UTF-8 XML encoding declaration requirement. |
| docs/reqstream/test-results-library/io/serializer-helpers.yaml | Removes serializer-helpers requirements file (requirements moved elsewhere). |
| docs/reqstream/test-results-library/io/junit-serializer.yaml | Adds JUnit UTF-8 XML encoding declaration requirement. |
| docs/reqstream/test-results-library/io/io.yaml | Removes child link to the deleted serializer-helpers requirement. |
| docs/reqstream/ots/weasyprinttool.yaml | Removes placeholder WeasyPrintTool OTS file. |
| docs/reqstream/ots/weasyprint.yaml | Adds concrete WeasyPrint OTS requirements with FileAssert-based evidence. |
| docs/reqstream/ots/versionmark.yaml | Updates VersionMark OTS description text. |
| docs/reqstream/ots/sonarscanner.yaml | Removes placeholder SonarScanner OTS file. |
| docs/reqstream/ots/sonarmark.yaml | Updates SonarMark OTS description text. |
| docs/reqstream/ots/sarifmark.yaml | Updates SarifMark OTS description text. |
| docs/reqstream/ots/reviewmark.yaml | Updates ReviewMark OTS description text. |
| docs/reqstream/ots/reqstream.yaml | Updates ReqStream OTS description text. |
| docs/reqstream/ots/pandoctool.yaml | Removes placeholder PandocTool OTS file. |
| docs/reqstream/ots/pandoc.yaml | Adds concrete Pandoc OTS requirements with FileAssert-based evidence. |
| docs/reqstream/ots/mstest.yaml | Replaces placeholder MSTest OTS text with a concrete requirement and tests list. |
| docs/reqstream/ots/fileassert.yaml | Adds FileAssert OTS requirements and self-validation evidence. |
| docs/reqstream/ots/buildmark.yaml | Updates BuildMark OTS description text. |
| build.sh | Removes legacy bash build script (replaced by build.ps1). |
| build.ps1 | Adds unified PowerShell build-and-test script. |
| build.bat | Removes legacy batch build script (replaced by build.ps1). |
| SECURITY.md | Rewrites security policy to be clearer and more structured. |
| CONTRIBUTING.md | Updates contribution workflow, standards, and new fix.ps1/lint.ps1 guidance. |
| ARCHITECTURE.md | Removes architecture doc (architecture content expected elsewhere). |
| AGENTS.md | Updates agent guidance, tooling references, and scope/formatting rules. |
| .yamllint.yaml | Ignores .agent-logs/ directory for yamllint. |
| .yamlfix.toml | Adds yamlfix configuration aligned with yamllint rules. |
| .versionmark.yaml | Adds FileAssert tool capture regex. |
| .reviewmark.yaml | Updates review patterns/review-sets and includes user guide docs. |
| .markdownlint-cli2.yaml | Disables markdownlint-cli2 banner/progress output. |
| .github/workflows/release.yaml | Adjusts release body file handling and artifact usage. |
| .github/workflows/build_on_push.yaml | Cleans up workflow triggers formatting and comments. |
| .github/workflows/build.yaml | Switches CI linting to lint.ps1, adds doc build steps, integrates Pandoc/WeasyPrint/FileAssert. |
| .github/standards/testing-principles.md | Updates requirements/test linkage guidance. |
| .github/standards/technical-documentation.md | Clarifies doc structure requirements (Pandoc collections, nested subsystems). |
| .github/standards/software-items.md | Expands software item taxonomy (adds “Software Package”) and guidance. |
| .github/standards/reviewmark-usage.md | Updates ReviewMark usage patterns and nested subsystem conventions. |
| .github/standards/requirements-principles.md | Adds new requirements principles standard doc. |
| .github/standards/reqstream-usage.md | Updates ReqStream guidance to reference requirements principles and improve clarity. |
| .github/standards/design-documentation.md | Updates design doc structure guidance to allow nested subsystems and companion artifacts. |
| .github/standards/csharp-testing.md | Minor wording update for standards scope. |
| .github/standards/csharp-language.md | Adds guidance to run pwsh ./fix.ps1. |
| .github/standards/coding-principles.md | Refines literate programming expectations and structure guidance. |
| .github/agents/software-architect.agent.md | Adds a new user-invocable software architect agent definition. |
| .github/agents/repo-consistency.agent.md | Updates reporting requirements and template wording. |
| .github/agents/quality.agent.md | Updates quality agent workflow and report template. |
| .github/agents/lint-fix.agent.md | Adds a lint-fix agent definition and fix-loop process. |
| .github/agents/implementation.agent.md | Updates implementation orchestrator state machine and reporting. |
| .github/agents/formal-review.agent.md | Renames/updates formal review agent and adds standards references. |
| .github/agents/developer.agent.md | Updates developer agent workflow, pre-flight, and reporting expectations. |
| .fileassert.yaml | Adds FileAssert checks for generated HTML/PDF artifacts across doc sets. |
| .cspell.yaml | Simplifies cspell word list and ignore paths. |
| .config/dotnet-tools.json | Adds demaconsulting.fileassert dotnet tool to the tool manifest. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This was referenced Jun 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request
Description
This PR updates the repository with new agents, scripts, and fixes requirements drift.
Type of Change
Related Issues
Closes #
Pre-Submission Checklist
Before submitting this pull request, ensure you have completed the following:
Build and Test
dotnet build --configuration Releasedotnet test --configuration ReleaseCode Quality
dotnet format --verify-no-changesQuality Checks
Please run the following checks before submitting:
./lint.sh(Unix/macOS) orcmd /c lint.bat/./lint.bat(Windows)Testing
Documentation
Additional Notes