Skip to content

Remove scope labels from context output and update README example#80

Merged
Malcolmnixon merged 6 commits into
mainfrom
fix/78-context-cleanup
Jun 23, 2026
Merged

Remove scope labels from context output and update README example#80
Malcolmnixon merged 6 commits into
mainfrom
fix/78-context-cleanup

Conversation

@Malcolmnixon

Copy link
Copy Markdown
Member

This pull request updates the way context files are displayed in review documentation and related outputs. Instead of labeling context files as [global] or [local], the files are now listed as plain paths, with global context files appearing first, followed by per-review-set files. This change is reflected in the documentation, implementation, and tests to ensure consistency throughout the codebase.

Documentation updates:

  • Updated user guides, design docs, and requirements to describe context files as plain paths, removing references to [global] and [local] labels. [1] [2] [3] [4] [5]

Implementation changes:

  • Modified ElaborateReviewSet in ReviewMarkConfiguration.cs to output context files as plain paths, with global files listed before per-review-set files, and removed the labeling logic.

Test updates:

  • Updated test descriptions and assertions to check for plain file paths in the context subsection, removing checks for [global] and [local] labels. [1] [2] [3]

Example and configuration updates:

  • Updated the example README.md and YAML configuration to match the new context file display format.

These changes ensure a simpler and more consistent presentation of context files across documentation, code, and tests.

Malcolm Nixon and others added 2 commits June 22, 2026 20:05
…lobal context example

- Context files in --elaborate output are now listed as plain paths
  without [global]/[local] scope prefixes
- Global context files still appear before local context files
- Add top-level context: example to README .reviewmark.yaml schema
- Update tests and docs to match new plain-path output

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…rification docs

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 23, 2026 00:10
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request simplifies how context files are presented in ReviewMark elaboration output and documentation by removing [global]/[local] scope labels and listing context entries as plain file paths (with global context shown before per-review-set context).

Changes:

  • Updated ElaborateReviewSet to emit context entries as plain paths (no scope labels), with global context files listed first.
  • Updated documentation and requirements text to describe the new context display format.
  • Updated tests and README example configuration to match the new output format.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
test/DemaConsulting.ReviewMark.Tests/Configuration/ReviewMarkConfigurationTests.cs Updates assertions/descriptions for context output; needs stronger assertions for the new format and ordering.
src/DemaConsulting.ReviewMark/Configuration/ReviewMarkConfiguration.cs Removes scope-labeling logic and outputs plain context paths with global-first ordering.
README.md Updates example .reviewmark.yaml to include top-level context: and reflect new behavior.
docs/verification/review-mark/configuration/review-mark-configuration.md Updates verification expectations to “plain path” context entries.
docs/user_guide/introduction.md Updates example --elaborate output to list context as plain paths.
docs/reqstream/review-mark/configuration/review-mark-configuration.yaml Updates requirement text to specify plain paths and global-first ordering.
docs/design/review-mark/configuration/review-mark-configuration.md Updates design documentation for ElaborateReviewSet context output behavior.
docs/design/review-mark/configuration.md Updates configuration design overview to reflect plain-path context listing.

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

Malcolm Nixon and others added 2 commits June 22, 2026 20:17
- Move block-level evidence-source and context comments to own lines
- Remove redundant inline comment from per-review-set context:
- Normalise inline comment alignment to column 26

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Assert exact list-item format (- \path\) not just substring contains
- Assert DoesNotContain [global]/[local] labels in both context tests
- Add GlobalContextBeforeLocalContext test to verify ordering

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 8 out of 8 changed files in this pull request and generated 1 comment.

Comment thread src/DemaConsulting.ReviewMark/Configuration/ReviewMarkConfiguration.cs Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@Malcolmnixon Malcolmnixon merged commit b6555d3 into main Jun 23, 2026
15 checks passed
@Malcolmnixon Malcolmnixon deleted the fix/78-context-cleanup branch June 23, 2026 00:45
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