Add context for review process#19
Merged
Merged
Conversation
…larification Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…tocol standards Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refines the repository’s distributable standards and agent instructions around ReviewMark usage, particularly clarifying review-set structure and the intended role of context files during formal reviews.
Changes:
- Updated the ReviewMark usage standard with clearer review type definitions, examples, and explicit context file guidance.
- Expanded design documentation guidance about avoiding dependency version numbers while permitting stable standard identifiers.
- Adjusted the formal review agent procedure to distinguish “context” vs “files under review.”
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/.github/standards/reviewmark-usage.md | Restructures ReviewMark guidance, adds context file section/table, and refines review-set definitions/examples. |
| src/.github/standards/design-documentation.md | Clarifies what “version numbers” means in design docs and provides allowed exceptions/examples. |
| src/.github/agents/formal-review.agent.md | Updates the formal review steps to explicitly incorporate ReviewMark’s Context vs Files distinction. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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 updates the documentation and standards for using ReviewMark, focusing on clarifying the structure and requirements for review-sets, introducing explicit context file handling, and improving the organization and readability of the review process. The changes provide more detailed guidance on how to configure and conduct reviews, especially regarding the use of context files to aid reviewers, and refine the documentation for different types of reviews.
The most important changes are:
Major Documentation and Standards Updates:
.reviewmark.yaml, and added a dedicated section and table explaining which context files to include for each review type.Purpose,Decomposition,Architecture,Design,Verification,AllRequirements, subsystem/unit reviews, OTS, and Shared Package), including explicit context file requirements for each. [1] [2] [3] [4] [5] [6] [7]Process and Quality Check Enhancements:
.reviewmark.yamlfor clarity and accuracy.These changes make the review process more rigorous and reviewer-friendly by ensuring all necessary background information is provided as context, and by making the documentation more prescriptive and easier to follow.