Update repository structure to comply with updated standards#53
Conversation
Agent-Logs-Url: https://github.com/demaconsulting/VersionMark/sessions/1ea5028d-5448-48db-85cb-9d854d84f346 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Agent-Logs-Url: https://github.com/demaconsulting/VersionMark/sessions/430a33c9-779c-4076-bea5-7c7464a4bdfe Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
|
@copilot The OTS requirements still need to be reviewed - otherwise they would result in unreviewed files; but they can be reviewed in unison under a single review and probably use a glob-pattern to pick up all OTS software. |
Agent-Logs-Url: https://github.com/demaconsulting/VersionMark/sessions/723a8247-07b9-47f3-ae09-8802b6927a61 Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Added a single |
Agent-Logs-Url: https://github.com/demaconsulting/VersionMark/sessions/e7bba166-922d-4566-b14d-c2db9e1d1e0b Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
|
@copilot Please fix the issues reported by linting |
There was a problem hiding this comment.
Pull request overview
Aligns the repository’s requirements and review/documentation structure with the updated .github/standards, primarily by renaming/moving ReqStream requirement files and updating downstream references so ReqStream and ReviewMark continue to work with the new layout.
Changes:
- Renamed/reorganized
docs/reqstream/**requirements files (including moving OTS requirements underdocs/reqstream/ots/) and updatedrequirements.yamlincludes accordingly. - Updated
.reviewmark.yamlreview-set paths to point at the renamed requirement files. - Updated design documentation references to the new requirements filenames.
Reviewed changes
Copilot reviewed 3 out of 25 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| requirements.yaml | Updates ReqStream includes to new docs/reqstream/** paths (including ots/). |
| docs/reqstream/system.yaml | Adds/renames system requirements file under new naming convention. |
| docs/reqstream/cli/cli.yaml | Adds/renames CLI subsystem requirements under new naming convention. |
| docs/reqstream/cli/program.yaml | Adds/renames Program unit requirements under new naming convention. |
| docs/reqstream/cli/context.yaml | Adds/renames Context unit requirements under new naming convention. |
| docs/reqstream/capture/capture.yaml | Adds/renames Capture subsystem requirements under new naming convention. |
| docs/reqstream/capture/version-info.yaml | Adds/renames VersionInfo unit requirements under new naming convention. |
| docs/reqstream/publishing/publishing.yaml | Adds/renames Publishing subsystem requirements under new naming convention. |
| docs/reqstream/publishing/markdown-formatter.yaml | Adds/renames MarkdownFormatter unit requirements under new naming convention. |
| docs/reqstream/configuration/configuration.yaml | Adds/renames Configuration subsystem requirements under new naming convention. |
| docs/reqstream/configuration/version-mark-config.yaml | Adds/renames VersionMarkConfig unit requirements under new naming convention. |
| docs/reqstream/configuration/tool-config.yaml | Adds/renames ToolConfig unit requirements under new naming convention. |
| docs/reqstream/linting/linting.yaml | Adds/renames Linting subsystem requirements under new naming convention. |
| docs/reqstream/linting/lint.yaml | Adds/renames Lint unit requirements under new naming convention. |
| docs/reqstream/self-test/self-test.yaml | Adds/renames SelfTest subsystem requirements under new naming convention. |
| docs/reqstream/self-test/validation.yaml | Adds/renames Validation unit requirements under new naming convention. |
| docs/reqstream/self-test/path-helpers.yaml | Adds/renames PathHelpers unit requirements under new naming convention. |
| docs/reqstream/ots/mstest.yaml | Moves OTS MSTest requirements under docs/reqstream/ots/. |
| docs/reqstream/ots/reqstream.yaml | Moves OTS ReqStream requirements under docs/reqstream/ots/. |
| docs/reqstream/ots/buildmark.yaml | Moves OTS BuildMark requirements under docs/reqstream/ots/. |
| docs/reqstream/ots/sarifmark.yaml | Moves OTS SarifMark requirements under docs/reqstream/ots/. |
| docs/reqstream/ots/sonarmark.yaml | Moves OTS SonarMark requirements under docs/reqstream/ots/. |
| docs/reqstream/ots/reviewmark.yaml | Moves OTS ReviewMark requirements under docs/reqstream/ots/. |
| docs/design/system.md | Updates prose reference from old system requirements filename to system.yaml. |
| .reviewmark.yaml | Updates review-set paths to match renamed/moved reqstream files. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Agent-Logs-Url: https://github.com/demaconsulting/VersionMark/sessions/e0a8b5ca-8fb8-40ca-a98b-c187d2bc013d Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
Fixed in e653b8c — a trailing blank line left behind when the OTS review set was removed was causing a yamllint Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Aligns repository structure with updated
.github/standardsfor design documentation, reqstream requirements, and reviewmark file reviews.docs/reqstream/file renamesFiles renamed from
subsystem-{name}.yaml/unit-{name}.yamlpattern to{name}.yamlperreqstream-usage.md:versionmark-system.yaml→system.yamlcli/subsystem-cli.yaml→cli/cli.yaml,unit-program.yaml→program.yaml,unit-context.yaml→context.yamlcapture/subsystem-capture.yaml→capture.yaml,unit-version-info.yaml→version-info.yamlpublishing/subsystem-publishing.yaml→publishing.yaml,unit-formatter.yaml→markdown-formatter.yamlconfiguration/subsystem-configuration.yaml→configuration.yaml,unit-version-mark-config.yaml→version-mark-config.yaml,unit-tool-config.yaml→tool-config.yamllinting/subsystem-linting.yaml→linting.yaml,unit-lint.yaml→lint.yamlself-test/subsystem-selftest.yaml→self-test.yaml,unit-validation.yaml→validation.yaml,unit-path-helpers.yaml→path-helpers.yamlOTS requirements reorganised
ots-*.yamlfiles moved intodocs/reqstream/ots/subfolder asots/{name}.yaml. No separate OTS review set is needed — the existingVersionMark-AllRequirementsreview already covers all files underdocs/reqstream/**/*.yaml.Downstream updates
requirements.yaml— all includes updated to new paths.reviewmark.yaml— all review-set paths updated to reflect renamed reqstream files; no separate OTS review set as OTS files are covered byVersionMark-AllRequirements; trailing blank line removed to satisfy yamllintempty-linesruledocs/design/system.md— prose reference updated fromversionmark-system.yamltosystem.yamlType of Change
Related Issues
Pre-Submission Checklist
Before submitting this pull request, ensure you have completed the following:
Build and Test
dotnet build --configuration Releasedotnet test --configuration Releasedotnet run --project src/DemaConsulting.VersionMark --configuration Release --framework net10.0--no-build -- --validateCode Quality
dotnet format --verify-no-changesQuality Checks
Please run the following checks before submitting:
cspell "**/*.{md,cs}"markdownlint "**/*.md"yamllint .Testing
Documentation
Additional Notes
No source or test code changed. All changes are documentation, requirements, and review configuration files.