Skip to content

Update repository structure to comply with updated standards#53

Merged
Malcolmnixon merged 5 commits intomainfrom
copilot/update-repository-to-comply-with-standards
Apr 2, 2026
Merged

Update repository structure to comply with updated standards#53
Malcolmnixon merged 5 commits intomainfrom
copilot/update-repository-to-comply-with-standards

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 2, 2026

Aligns repository structure with updated .github/standards for design documentation, reqstream requirements, and reviewmark file reviews.

docs/reqstream/ file renames

Files renamed from subsystem-{name}.yaml/unit-{name}.yaml pattern to {name}.yaml per reqstream-usage.md:

  • versionmark-system.yamlsystem.yaml
  • cli/subsystem-cli.yamlcli/cli.yaml, unit-program.yamlprogram.yaml, unit-context.yamlcontext.yaml
  • capture/subsystem-capture.yamlcapture.yaml, unit-version-info.yamlversion-info.yaml
  • publishing/subsystem-publishing.yamlpublishing.yaml, unit-formatter.yamlmarkdown-formatter.yaml
  • configuration/subsystem-configuration.yamlconfiguration.yaml, unit-version-mark-config.yamlversion-mark-config.yaml, unit-tool-config.yamltool-config.yaml
  • linting/subsystem-linting.yamllinting.yaml, unit-lint.yamllint.yaml
  • self-test/subsystem-selftest.yamlself-test.yaml, unit-validation.yamlvalidation.yaml, unit-path-helpers.yamlpath-helpers.yaml

OTS requirements reorganised

ots-*.yaml files moved into docs/reqstream/ots/ subfolder as ots/{name}.yaml. No separate OTS review set is needed — the existing VersionMark-AllRequirements review already covers all files under docs/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 by VersionMark-AllRequirements; trailing blank line removed to satisfy yamllint empty-lines rule
  • docs/design/system.md — prose reference updated from versionmark-system.yaml to system.yaml

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

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

  • Spell checker passes: cspell "**/*.{md,cs}"
  • Markdown linter passes: markdownlint "**/*.md"
  • YAML linter passes: yamllint .

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 source or test code changed. All changes are documentation, requirements, and review configuration files.

@Malcolmnixon
Copy link
Copy Markdown
Member

@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.

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 2, 2026

@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 p...

Added a single VersionMark-OTS-Components review set using docs/reqstream/ots/*.yaml to cover all OTS requirements in one review in 27b3a5e.

Copilot stopped work on behalf of Malcolmnixon due to an error April 2, 2026 13:12
Copilot AI requested a review from Malcolmnixon April 2, 2026 13:16
@Malcolmnixon Malcolmnixon marked this pull request as ready for review April 2, 2026 13:21
Copilot AI review requested due to automatic review settings April 2, 2026 13:21
@Malcolmnixon
Copy link
Copy Markdown
Member

@copilot Please fix the issues reported by linting

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

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 under docs/reqstream/ots/) and updated requirements.yaml includes accordingly.
  • Updated .reviewmark.yaml review-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.

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 2, 2026

@copilot Please fix the issues reported by linting

Fixed in e653b8c — a trailing blank line left behind when the OTS review set was removed was causing a yamllint empty-lines error. All linting now passes.

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:

  • https://storage.googleapis.com/chromium-browser-snapshots/Linux_x64/1108766/chrome-linux.zip
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node node install.js (http block)

If you need me to access, download, or install something from one of these locations, you can either:

@Malcolmnixon Malcolmnixon merged commit d87a2e4 into main Apr 2, 2026
15 checks passed
@Malcolmnixon Malcolmnixon deleted the copilot/update-repository-to-comply-with-standards branch April 2, 2026 13:52
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