docs: add evaluation-readiness index page - #440
Merged
El-swaggerito merged 1 commit intoJul 29, 2026
Conversation
Fixes Axionvera#433. Adds docs/evaluation-readiness.md — a single page linking the payment expectation guide, testing standard, CI guidance, acceptance criteria audit template, self-assessment form, and reviewer checklist that were previously scattered across README, PR templates, and separate docs. Also links the payment-period conduct guidance from the pocketpay-contracts repo, since that document is shared across the PocketPay GrantFox campaign rather than duplicated per-repo. README docs index links the new page.
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 #433
Adds
docs/evaluation-readiness.md— a single index page linking the payment expectationguide, testing standard, CI guidance, acceptance criteria audit template, self-assessment
form, and reviewer checklist, which were previously scattered across README, the PR template,
and separate docs. README's docs index links the new page.
Issue scope
docs/evaluation-readiness.mddocs/evaluation-readiness.md§ "1. Payment expectations" →docs/meaningful-change-review.mdtesting.md,module-test-matrix.md,coverage-baseline.mdpre-pr-verification.md,pre-submission-verification.md,local-verification.md.github/checklists/acceptance-criteria.template.mdcontributor-self-review.template.md; § "6. Reviewer checklist" →contribution-quality-gate.md(doc + checklist)Affected packages / apps
docs/apps/webTesting performed
Docs-only change — no build/test surface affected. Verified by inspection: every doc and
checklist file linked from the new index page was confirmed to actually exist in this repo
(
docs/or.github/checklists/) before linking, with one exception noted below.Security impact
admin/authorization logic.
Documentation impact
/docsupdated for this change.Risk / follow-ups
The issue also asks for a "communication policy" to be linked. This repo doesn't have one —
docs/meaningful-change-review.mdalready references a "Payment-Period Conduct Note" thatlives in the
pocketpay-contractsrepo instead, since it's shared across the whole PocketPayGrantFox campaign rather than duplicated per-repo. I confirmed that doc exists there
(
pocketpay-contracts/docs/payment-period-conduct.md) and linked to it directly rather thaninventing a duplicate copy in this repo. Flagging in case a maintainer would prefer a local
copy instead of a cross-repo link.