docs: add reviewer evidence checklist - #551
Closed
CleanDev-Fix wants to merge 2 commits into
Closed
Conversation
Contributor
| \nThis PR is currently a draft.\n\nThe auto-merge automation will not merge draft pull requests. |
Author
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.
Closes #542
Summary
Adds a maintainer-side reviewer evidence checklist for deciding whether a
PocketPay Contracts PR is complete and evaluation-ready. The guide organizes
scope, implementation, tests, exact-head CI, acceptance criteria,
documentation/risk, and evidence-specific review outcomes.
Changes
docs/reviewer-evidence-checklist.md, linking the existing quality,traceability, testing, security, and documentation-style sources;
and
CONTRIBUTING.md.Contract Functions Changed
None. This is a documentation-only change.
Tests Added or Updated
None. No executable or contract behavior changed.
Security Considerations
No security impact. The checklist points reviewers to the existing contract
security source and does not alter balances, authorization, storage, events,
external calls, dependencies, or workflows.
Commands Run
git diff --check— PASS (line-ending warnings only; no whitespace errors)The Rust/contract suite was not run because the patch changes Markdown only.
CI Status
This PR is intentionally a draft until relevant hosted checks are visible and
green.
Traceability Table
docs/reviewer-evidence-checklist.mdaddedContributor Self-Review
duplicating their details.
behavior changes.
Known limitation: the Rust/contract suite was not run because no executable
behavior changed.