Skip to content

Commit 2956875

Browse files
committed
mobile evaluation checklist
1 parent 554872c commit 2956875

3 files changed

Lines changed: 34 additions & 32 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ We strive to build a wallet that is accessible to everyone. Before submitting a
213213
- Reference any related issues using `Closes #<issue-number>`.
214214
- Describe how you tested the change.
215215
- Note any accessibility or security considerations.
216-
- For GrantFox contract issues, review the [Evaluation Readiness Checklist](docs/evaluation-readiness-checklist.md) before the payment evaluation period. A merged PR does not guarantee payment approval.
216+
- For GrantFox mobile issues, review the [Evaluation Readiness Checklist](docs/evaluation-readiness-checklist.md) before the payment evaluation period. A merged PR does not guarantee payment approval.
217217

218218
7. A maintainer will review your PR. Please respond to feedback and update your branch as needed.
219219

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ React Native Expo wallet for Stellar Testnet. The app aims to feel polished and
1212
## Documentation
1313

1414
- [Architecture Readiness Review](./docs/architecture-readiness-review.md) - Feature boundaries, duplicated state, SDK integration blockers, security-sensitive areas, and test gaps
15-
- [Evaluation Readiness Checklist](./docs/evaluation-readiness-checklist.md) - GrantFox contributor checklist for contract issues, including tests, CI, issue requirements, edge cases, and the reminder that merge does not guarantee payment approval
15+
- [Evaluation Readiness Checklist](./docs/evaluation-readiness-checklist.md) - GrantFox contributor checklist for mobile issues, including tests, CI, screenshots, acceptance criteria, and the reminder that merge does not guarantee payment approval
1616
- [Storage Guide](./docs/storage.md) - SecureStore vs AsyncStorage
1717
- [Contacts Guide](./docs/contacts.md) - Contact storage, backup limitations, and future export/import ideas
1818
- [Polyfills Guide](./docs/polyfills.md) - React Native polyfills and import order for Stellar SDK
@@ -48,7 +48,7 @@ PocketPay Mobile is part of a broader PocketPay stack:
4848

4949
- [Screen Inventory](docs/screen-inventory.md) - A map of the main screens and routes in the app.
5050
- [Mobile Onboarding Checklist](docs/mobile-onboarding-checklist.md) - Quick-reference setup checklist for new contributors
51-
- [Evaluation Readiness Checklist](docs/evaluation-readiness-checklist.md) - Contract-issue review checklist for GrantFox contributors before payment evaluation
51+
- [Evaluation Readiness Checklist](docs/evaluation-readiness-checklist.md) - Mobile-issue review checklist for GrantFox contributors before payment evaluation
5252
- [UI State Catalogue](docs/ui-states.md) and [Accessibility Checklist](docs/accessibility.md) - Governance for major-screen states, shared component contracts, and accessible review evidence
5353
- [QR Receive Payload Format](docs/qr-payment-requests.md) - The address-only and SEP-0007-based payment-request formats the Receive screen encodes into its QR code
5454

docs/evaluation-readiness-checklist.md

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
## Purpose
44

5-
This checklist is for GrantFox contributors working on contract issues. Use it before the payment evaluation period begins.
5+
This checklist is for GrantFox contributors working on mobile issues. Use it before the payment evaluation period begins.
66

7-
> Merging a contract PR does **not** guarantee payment approval. Approval still depends on evaluator review, passing checks, adequate tests, issue compliance, and overall implementation quality.
7+
> Merging a mobile PR does **not** guarantee payment approval. Approval still depends on evaluator review, passing checks, adequate testing evidence, issue compliance, meaningful implementation, and overall quality.
88
99
## When To Use This Checklist
1010

11-
- Before requesting final review on a contract issue PR
11+
- Before requesting final review on a mobile issue PR
1212
- Before the payment evaluation period starts
1313
- After every substantial code, test, or scope update
1414

@@ -19,55 +19,56 @@ This checklist is for GrantFox contributors working on contract issues. Use it b
1919
- [ ] I re-read the linked issue and matched the requested scope exactly.
2020
- [ ] I confirmed the implementation satisfies the issue acceptance criteria.
2121
- [ ] I documented any intentional scope limits, assumptions, or follow-up work in the PR.
22-
- [ ] I verified the contract behavior matches the expected user or protocol outcome.
22+
- [ ] I verified the mobile behavior matches the expected user experience and issue outcome.
2323
- [ ] I removed unfinished work, placeholders, dead code, and misleading TODOs that could affect evaluation.
2424

25-
### 2. Contract Correctness
25+
### 2. Meaningful Implementation
2626

27-
- [ ] I reviewed all changed contract paths for happy-path correctness.
28-
- [ ] I reviewed failure paths and verified the contract rejects invalid inputs safely.
29-
- [ ] I checked authorization, signer, and caller assumptions.
30-
- [ ] I confirmed state transitions are valid before and after each write.
31-
- [ ] I verified arithmetic, rounding, overflow/underflow, and precision-sensitive logic.
27+
- [ ] I made a real implementation change that solves the issue instead of a superficial workaround.
28+
- [ ] I reviewed happy-path behavior across the affected screens, hooks, stores, or services.
29+
- [ ] I reviewed failure, loading, empty, and disabled states introduced or affected by the change.
30+
- [ ] I confirmed navigation, state updates, and user actions behave correctly before and after the change.
31+
- [ ] I checked that naming, copy, and code structure make the implementation easy for evaluators to follow.
3232

33-
### 3. Tests
33+
### 3. Mobile Testing Evidence
3434

3535
- [ ] I added or updated tests for the main behavior introduced by the issue.
3636
- [ ] I added regression coverage for the bug or edge case that motivated the change.
37-
- [ ] I covered both success and failure paths where the contract can branch.
38-
- [ ] I verified test fixtures and mocks still reflect real contract expectations.
39-
- [ ] I confirmed the tests would help an evaluator understand why the change is correct.
37+
- [ ] I covered both success and failure paths where the mobile flow can branch.
38+
- [ ] I verified test fixtures, mocks, and app state setup still reflect real usage expectations.
39+
- [ ] I manually tested the affected flow in the app and captured concise verification notes in the PR.
4040

4141
### 4. CI And Verification
4242

4343
- [ ] All required CI checks pass on the PR.
44-
- [ ] Local test commands for the affected contract area pass before review.
44+
- [ ] Local test commands for the affected mobile area pass before review.
4545
- [ ] Any lint, formatting, type, or static-analysis checks required by the repo pass.
4646
- [ ] I did not ignore, mute, or bypass failing checks to get the PR merged.
4747
- [ ] I included clear verification notes in the PR description.
4848

49-
### 5. Security Review
49+
### 5. Screenshots Or Recordings
5050

51-
- [ ] I reviewed access control and confirmed only authorized actors can trigger privileged behavior.
52-
- [ ] I checked for unsafe assumptions around external inputs, contract calls, and user-provided values.
53-
- [ ] I reviewed replay, duplicate execution, and unexpected re-entry or repeated-call scenarios where relevant.
54-
- [ ] I confirmed sensitive operations fail safely and leave the contract in a valid state.
55-
- [ ] I verified there are no debug shortcuts, test-only bypasses, or insecure defaults left in the change.
51+
- [ ] I attached screenshots or a short screen recording when the issue changes visible UI or user flow.
52+
- [ ] The media clearly shows the final state that should be evaluated.
53+
- [ ] I avoided placeholder evidence that does not demonstrate the actual fix or feature.
54+
- [ ] I made sure screenshots or recordings do not expose secrets, personal data, or unsafe debug information.
55+
- [ ] If the change is non-visual, I explained why screenshots or recordings are not applicable.
5656

57-
### 6. Edge Cases
57+
### 6. Acceptance Criteria And Edge Cases
5858

5959
- [ ] I tested zero, minimum, maximum, empty, and invalid input cases where applicable.
60-
- [ ] I reviewed boundary conditions for timestamps, counters, balances, and collection sizes.
61-
- [ ] I checked behavior when preconditions are missing or previous state is inconsistent.
62-
- [ ] I verified error messages or failure reasons remain clear enough for maintainers to evaluate quickly.
63-
- [ ] I considered upgrade, migration, or compatibility risks if the issue touches persisted state or interfaces.
60+
- [ ] I reviewed boundary conditions for form inputs, network states, persisted state, and repeated user actions.
61+
- [ ] I checked behavior when preconditions are missing, stale, offline, or partially loaded.
62+
- [ ] I verified errors, validation, and recovery actions remain clear enough for evaluators to review quickly.
63+
- [ ] I checked each acceptance-criteria item one by one and confirmed it is satisfied in the implementation or evidence.
6464

6565
### 7. Self-Review
6666

6767
- [ ] I reviewed the full diff as if I were the evaluator.
6868
- [ ] I removed unrelated changes that could make the issue harder to evaluate.
69-
- [ ] I made sure naming, comments, and documentation explain non-obvious contract behavior.
69+
- [ ] I made sure naming, comments, and documentation explain non-obvious mobile behavior.
7070
- [ ] I confirmed the PR description links the issue and explains what was tested.
71+
- [ ] I honestly checked that the implementation is substantial enough to justify payment evaluation.
7172
- [ ] I am confident the work is ready for evaluation even if I am not available to clarify it live.
7273

7374
## Final Reminder
@@ -76,8 +77,9 @@ Before the payment evaluation period starts, make sure the PR is fully reviewabl
7677

7778
- [ ] The implementation matches the issue requirements.
7879
- [ ] Tests and CI are passing.
79-
- [ ] Security and edge cases were reviewed.
80+
- [ ] Screenshot or recording evidence is included when applicable.
8081
- [ ] Acceptance criteria were checked one by one.
82+
- [ ] The implementation is meaningful and evaluator-ready.
8183
- [ ] The PR is evaluator-ready.
8284

83-
If any box is still unchecked, treat the work as not yet ready for payment evaluation.
85+
If any box is still unchecked, treat the work as not yet ready for payment evaluation.

0 commit comments

Comments
 (0)