Problem Statement
When holding a review, the reviewer needs the list of files to review and the fingerprint. ReviewMark should support providing this information.
Proposed Solution
Add a --elaborate [review-set] command which causes the tool to print (formatted as Markdown) an elaboration of the review including:
- The ID of the review
- The fingerprint of the review
- The full list of files to review (relative to the working directory) sorted alphabetically
This will need requirements, unit-tests, self-validation, and updates to the documentation (readme, theory-of-operations, and guide).
Alternatives Considered
No response
Usage Examples
`dotnet reviewmark --elaborate Core-Logic`
Benefits
When holding a review, this provides the review information necessary for the review documentation - excluding the date and result which the reviewer(s) are responsible for populating when they execute the review.
Priority
High - Blocking my use case
Willingness to Contribute
Yes, I can submit a pull request
Additional Context
No response
Checklist
Problem Statement
When holding a review, the reviewer needs the list of files to review and the fingerprint. ReviewMark should support providing this information.
Proposed Solution
Add a
--elaborate [review-set]command which causes the tool to print (formatted as Markdown) an elaboration of the review including:This will need requirements, unit-tests, self-validation, and updates to the documentation (readme, theory-of-operations, and guide).
Alternatives Considered
No response
Usage Examples
Benefits
When holding a review, this provides the review information necessary for the review documentation - excluding the date and result which the reviewer(s) are responsible for populating when they execute the review.
Priority
High - Blocking my use case
Willingness to Contribute
Yes, I can submit a pull request
Additional Context
No response
Checklist