Repository navigation
Apply formal review fixes and documentation updates across all groups - #189
Merged
Merged
Conversation
- Fix heading depths, XmlDoc, AAA comments, and N/A contradictions - Rename CommandRegistry.cs -> CommandsRegistry.cs (class name match) - Rename mstest.yaml -> xunit.yaml (content was xUnit, not MSTest) - Move utility/utility.md -> utility.md (correct subsystem file location) - Add spdx.md subsystem design file; reclassify Spdx as subsystem - Fix 17 missing requirement file includes in requirements.yaml - Fix .reviewmark.yaml: PathHelpers and Wildcard review-sets had wrong files - Fix ValidateQuery, ValidateRenameId, ValidateNtia, ValidateRunNuGetWorkflow XmlDoc (stale copy-paste summaries, missing remarks/exception tags) - Fix Wildcard test naming convention and wrap assertions in Assert.Multiple - Fix PathHelpers ambiguous cref (Path.GetFullPath -> Path.GetFullPath(string)) - Various verification doc scenarios added, design doc accuracy fixes Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…pers, Wildcard) - ValidateUpdatePackage: added exception-propagation disclosure to Run() remarks, added <exception> tags to DoValidate(), guarded Directory.Delete with Directory.Exists check, fixed bare AAA labels, added class and method <remarks>, added IoError propagation test, updated design/verification/reqstream docs - PathHelpers: split compound SpdxTool-Utility-SafePath requirement into RejectTraversal + RejectAbsolutePath, added RejectNullArguments requirement, added NullBasePath and NullRelativePath tests, added class <remarks>, fixed bare AAA labels, added Algorithm sub-section to design doc, added NullArgumentRejection verification scenario, fixed inline comment - Wildcard: reordered <remarks> to follow <summary> on IsMatch, added class and method <remarks> to WildcardTests, fixed AAA comment form, added null argument tests and empty-string boundary tests, updated reqstream and verification docs - Also fixed pre-existing RunWorkflow.cs merge conflict corruption and RelationshipDirection.cs unresolvable GetValueOrDefault cref Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Fix XmlDoc tag ordering (exception before param in several files) - Fix 'unconditionally' anti-pattern in all SelfTest DoValidate remarks - Add sequential execution precondition to all SelfTest Run design docs - Add IOException/UnauthorizedAccessException exception docs throughout - Fix 'to console' code comments to 'Report validation result' - Add IoError test entries to reqstream YAML files - Change Wildcard class from public to internal - Fix duplicate/incorrect code comments - Fix design doc post-conditions for validate-update-package - Improve VersionRegex and WildcardToRegex summaries - Remove inconsistent thread-safety paragraphs from method docs - Various minor doc improvements across commands and self-test areas Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Fix Diagram.cs XML doc: FileNotFoundException -> CommandUsageException - Fix diagram.md error handling: FileNotFoundException -> CommandUsageException - Remove FindPackage from relationship-direction.md Callers (not a caller) - Add negative-depth case to context.md Error Handling section - Document Context.Depth effect in self-test.md and validate.md - Remove incorrect SelfTest reference from utility.md Overview - Fix escaped angle brackets in print.md method headings - Document RunBytes parameter validation in run-workflow.md - Add --silent/--log output routing to spdx-tool.md Data Flow - Fix SpdxTool-CommandExecution-SupportedCommands title (observable behavior) - Add CommandsRegistry_Commands_AllExpectedNames_ArePresent test link - Add tests: [SpdxTool_Basic] to SpdxTool-SelfTest-Basic requirement - Fix test name in ots/spdx-model.yaml (add _Run_ segment) - Fix test name in command-error-exception.yaml (add _Run_ segment) - Fix test name in commands-registry.yaml and program.yaml - Add SpdxWorkflowFile and SpdxToolCommand MSBuild property requirements - Add children link from SpdxTool-Commands-VariableExpansion to unit req - Fix test name in command-usage-exception.md (add _Run_ segment) - Fix utility wildcard pattern in verification/introduction.md - Add DefaultDepth scenario to verification/spdx-tool/context.md - Add UnsupportedResultExtension and SilentLogCombination scenarios - Extend YamlInputExtraction scenario to reference null-entry test - Document --depth flag in user_guide/validation.md - Add Query and Print command subsections in user_guide/usage.md - Move Context tests from ProgramTests/LogTests to new ContextTests.cs Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Fix test name in verification/ots/spdx-model.md (add _Run_ segment) - Add SpdxTool-OTS-SpdxModel-Validation requirement and scenario - Split compound SpdxTool-SelfTest-Validate into Validate + Report - Extend SelfTestValidationCollection summary (Console.Out redirection) - Add remarks to SelfTestTests.cs linking tests to requirement scenarios - Confirm CommandTests.cs needs CommandSequential collection (env vars) - Move unit-level tests from commands.yaml to command.yaml/commands-registry.yaml - Add 5 missing verification scenarios to verification/spdx-tool/commands.md - Fix Arrange/Act comment labels in CommandTests.cs - Add Command_GetMapString_NullMap_ReturnsNull test - Remove cross-level tests from utility.yaml SpdxTool-Utility-SharedHelpers - Remove cross-level tests from spdx.yaml SpdxTool-Spdx-SharedUtilities - Fix caller docs in spdx.md (Query/FindPackage -> Diagram/CopyPackage) - Add ArgumentNullException XML doc tags to SpdxHelpers.cs - Add Context_Create_NoDepthFlag_DefaultsDepthToOne unit test - Add SpdxTool-Context-InvalidDepthRejection/LogFileRejection requirements - Add Context unit tests for ExecutionState and ErrorCount - Update verification/spdx-tool/context.md (ContextTests.cs references) - Add test/**/ContextTests.cs to SpdxTool-Context review-set in .reviewmark.yaml - Expand InvalidOperationException XML doc on Context.Create - Remove superfluous --validate from NegativeDepth test args Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
![github-code-quality[bot]](https://avatars.githubusercontent.com/u/9919?s=60&v=4){kind=small}
This was referenced Oct 5, 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.
This pull request introduces several improvements to project tooling, documentation validation, and agent definitions. The most significant changes include the addition of a comprehensive
.fileassert.yamlfor document validation, updates to agent markdown files for clarity and workflow improvements, enhancements to the spelling dictionary, and adjustments to.config/dotnet-tools.jsonto improve tool configuration and add new tools.Document validation and tooling:
.fileassert.yamlfile to define validation tests for generated documents, ensuring that key outputs (HTML, PDF) from Pandoc and WeasyPrint are present and meet expected metadata and content requirements..config/dotnet-tools.jsonto add new tools (fileassert,dictionarymark), set"rollForward": falsefor all tools to ensure version consistency, and reorganized the tool list for clarity.Agent definitions and workflows:
code-review.agent.mdwith a new, more detailedformal-review.agent.md, clarifying the review process, required standards, and reporting format for formal reviews. [1] [2]developer.agent.mdto clarify the standards-based workflow, add explicit pre-flight verification, companion artifact update planning, and enhanced reporting requirements. [1] [2] [3]Spelling and terminology:
.cspell.yamlwith additional project-specific technical terms, tool names, and spelling variants to reduce false positives in spellchecking. [1] [2] [3] [4] [5] [6]