docs: add PR evidence checklist for contributors - #210
Merged
El-swaggerito merged 1 commit intoJul 30, 2026
Merged
Conversation
6 tasks
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.
Summary
Closes #138
Adds a contributor-facing PR Evidence Checklist to the Pull Request template to make required evidence explicit and easier to review. Updates the contributor documentation to reference the new checklist while reusing existing guidance and avoiding documentation duplication.
PR Evidence Checklist
Before requesting review, confirm the following evidence is present in this PR description. Each item links to detailed guidance. PRs missing evidence will be sent back for completion.
Closes #NNN.pnpm verify,pnpm contract:test,pnpm check:boundaries). See TEST_EVIDENCE_REQUIREMENT.md.Passing,Pending,Failing-fixed,Failing-unrelated, orSkippedwith supporting evidence. See FAILING_CI_RESPONSE_GUIDE.md.Issue scope
Fill in a completion table mapping every Acceptance Criterion from the issue to its status,
implementation evidence, and tests.
For cross-package issues, use docs/ACCEPTANCE_CRITERIA_TRACEABILITY.md to map each criterion to affected packages, tests, docs, examples, and behavior. See
docs/ACCEPTANCE_CRITERIA_COMPLETION.md for the full
format, status legend, and a worked example.
.github/PULL_REQUEST_TEMPLATE.md.TEST_EVIDENCE_REQUIREMENT.md.FAILING_CI_RESPONSE_GUIDE.md.ACCEPTANCE_CRITERIA_COMPLETION.md.Affected packages / apps
Check every workspace this PR touches (helps reviewers scope the diff and route it to the right
maintainer):
apps/webpackages/typespackages/configpackages/fixturespackages/validatorspackages/stellar-kitpackages/anchor-utilscontracts/treasury-escrowdocs/Testing performed
If any CI check is failing, summarize the failure and the fix or evidence that it is unrelated. See docs/FAILING_CI_RESPONSE_GUIDE.md.
Repository verification performed:
pnpm build(repository-wide): failed because the Rust contract package requirescargo, which was unavailable in the execution environment.pnpm build(TypeScript packages): all TypeScript packages built successfully.pnpm lint(repository-wide): blocked by the same missing Rust toolchain.Screenshots / recordings
Required for any
apps/webUI change. Mark N/A otherwise.Security impact
admin/authorization logic (see Secret leakage / Mainnet safety checklist below).
If checked, summarise the impact and mitigation here.
Documentation-only change. No security-relevant behavior was modified.
Documentation impact
/docsupdated for this change.Maintainer Review Checklist (self-check)
Paste the MAINTAINER_REVIEW_CHECKLIST.md Phase 1 into
your PR description and mark each item. Do not fill out Phase 2 (GrantFox reward-readiness) —
that is completed by the campaign reviewer after merge.
GrantFox reviewers can use docs/GRANTFOX_REVIEWER_CHECKLIST.md for scope, tests, CI, docs/examples, and acceptance-criteria review.
PR self-check
Closes #NNNin the PR body.pnpm verifypasses locally (format, lint, typecheck, test, build).pnpm check:boundariespasses locally (if anypackages/*/srcimport changed).pnpm contract:testpasses locally (if anything undercontracts/changed).Optionally use
pnpm verify:fullto cover verify + examples + boundaries + contract tests.Stellar network correctness
assertNetworkAllowedcalled before any Horizon/RPC call that could reach mainnet.Anchor and SEP flow correctness
validateCallbackUrlrejects non-HTTPS if callbacks touched.isTransitionValid/transitionused.neverchecks in status-to-message/badge switches.Payment intent and readiness correctness
PaymentIntentSchema.Soroban contract correctness (if
contracts/changed)require_admin().EvidenceAlreadySubmittedenforced).DuplicateRelease,ReleaseBeforeApproval,ApprovalAfterDisputeenforced.saturating_add/saturating_sub.Secret leakage (R0–R6)
/S[A-Z2-7]{50,}/is clean.Mainnet safety
assertNetworkAllowed.Tests
src/test.rs.Documentation
Risk / follow-ups
None.
Acceptance Criteria Audit
Not applicable. The acceptance criteria mapping above covers all issue requirements.
GrantFox payment expectations
Acknowledged. Merge does not guarantee payment. CI is intentionally left unchecked until GitHub Actions complete.
Contributor self-review
Completed. This PR updates only contributor-facing documentation, introduces no code changes, reuses existing guidance, avoids documentation duplication, and satisfies all acceptance criteria.