|
| 1 | +# Evaluation Readiness Index |
| 2 | + |
| 3 | +One page to check before you open a PR, and before you ask about payment |
| 4 | +status on a GrantFox-sourced issue. Contributor quality guidance for this SDK |
| 5 | +is intentionally split across several focused documents rather than one long |
| 6 | +file — this page is the map. |
| 7 | + |
| 8 | +If you've read everything linked here and satisfied it, your PR is ready for |
| 9 | +review. If you haven't, start here rather than in README, the PR template, or |
| 10 | +a support thread. |
| 11 | + |
| 12 | +## 1. Payment expectations |
| 13 | + |
| 14 | +- [Meaningful Change Review Guide](./meaningful-change-review.md) — what |
| 15 | + counts as real SDK work. Size is not the bar; completeness is. Covers |
| 16 | + insufficient vs. acceptable examples and the reviewer criteria used on |
| 17 | + every PR. |
| 18 | +- [Payment-Period Conduct Guidance](https://github.com/Axionvera/pocketpay-contracts/blob/main/docs/payment-period-conduct.md) |
| 19 | + *(in the `pocketpay-contracts` repo — shared across the PocketPay |
| 20 | + GrantFox campaign, not duplicated per-repo)* — how to communicate about |
| 21 | + payment status without repeating the same question across threads. |
| 22 | + |
| 23 | +## 2. Testing standard |
| 24 | + |
| 25 | +- [Testing](./testing.md) — unit vs. integration test lanes and the |
| 26 | + offline guarantee. |
| 27 | +- [SDK Module Test Matrix](./module-test-matrix.md) — required unit, |
| 28 | + fixture, error-path, and integration tests per major module. |
| 29 | +- [Test Coverage Baseline](./coverage-baseline.md) — generate coverage |
| 30 | + reports and changed-module expectations (`npm run coverage:baseline`). |
| 31 | + |
| 32 | +## 3. CI guidance |
| 33 | + |
| 34 | +- [Pre-PR Verification](./pre-pr-verification.md) — run `npm run verify:pr` |
| 35 | + before opening a pull request to confirm tests, docs, CI, and issue |
| 36 | + acceptance criteria. |
| 37 | +- [Pre-submission Verification](./pre-submission-verification.md) — run |
| 38 | + `npm run presubmit` before submitting a PR (lint, tests, coverage, build). |
| 39 | +- [Local Verification](./local-verification.md) — what the `npm run verify` |
| 40 | + pipeline actually checks, end to end. |
| 41 | + |
| 42 | +## 4. Acceptance criteria audit |
| 43 | + |
| 44 | +- [Acceptance Criteria Checklist template](../.github/checklists/acceptance-criteria.template.md) — |
| 45 | + copy this to `.github/checklists/issue-<number>.md`, paste the issue's |
| 46 | + acceptance criteria, and map each one to a concrete change before you |
| 47 | + open the PR. |
| 48 | + |
| 49 | +## 5. Self-assessment |
| 50 | + |
| 51 | +- [Contributor Self-Review Form](../.github/checklists/contributor-self-review.template.md) — |
| 52 | + complete this **before** requesting review or expecting payment approval. |
| 53 | + It's designed to catch the same gaps a maintainer would flag, earlier. |
| 54 | + |
| 55 | +## 6. Reviewer checklist |
| 56 | + |
| 57 | +- [Contribution Quality Gate](./contribution-quality-gate.md) — the same |
| 58 | + gate maintainers use before approving a PR: implementation, tests, CI |
| 59 | + status, docs, and acceptance criteria, with worked examples of what |
| 60 | + passes and what doesn't. |
| 61 | +- [Contribution Quality Gate checklist](../.github/checklists/contribution-quality-gate.md) — |
| 62 | + the literal checkbox form maintainers fill in during review. |
| 63 | + |
| 64 | +## Suggested order |
| 65 | + |
| 66 | +1. Read [Meaningful Change Review](./meaningful-change-review.md) once, before |
| 67 | + you start writing code. |
| 68 | +2. Copy the [Acceptance Criteria Checklist template](../.github/checklists/acceptance-criteria.template.md) |
| 69 | + and fill it in as you implement, not after. |
| 70 | +3. Before opening the PR: run `npm run verify:pr` |
| 71 | + ([Pre-PR Verification](./pre-pr-verification.md)), then complete the |
| 72 | + [Contributor Self-Review Form](../.github/checklists/contributor-self-review.template.md). |
| 73 | +4. If you're waiting on a review or payment decision, read |
| 74 | + [Payment-Period Conduct Guidance](https://github.com/Axionvera/pocketpay-contracts/blob/main/docs/payment-period-conduct.md) |
| 75 | + before posting a status question. |
0 commit comments