Skip to content

Commit 0dde788

Browse files
Promise278Promise278
authored
Add contributor self-review form for PocketPay SDK issues (#418)
1 parent aa17377 commit 0dde788

4 files changed

Lines changed: 149 additions & 0 deletions

File tree

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@
4848
- [ ] Criterion 2:
4949
- [ ] Criterion 3:
5050

51+
## Contributor Self-Review
52+
53+
<!-- Complete the self-review form before requesting review.
54+
See .github/checklists/contributor-self-review.template.md -->
55+
- [ ] Self-review form completed and attached
56+
5157
## Reviewer Notes
5258

5359
<!-- Anything a reviewer should know: design decisions, trade-offs, follow-ups,

‎.github/checklists/contributor-self-review.template.md‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Contributor Self-Review Form
2+
3+
> Complete this form **before** requesting review or expecting payment approval.
4+
> This helps you evaluate your work objectively and ensures nothing is missed.
5+
6+
## Issue
7+
8+
- **Number:** #<!-- issue number -->
9+
- **Title:** <!-- issue title -->
10+
- **Contributor:** <!-- your GitHub username -->
11+
12+
---
13+
14+
## 1. Requirements Review
15+
16+
Verify you have addressed every requirement from the issue.
17+
18+
- [ ] All acceptance criteria from the issue are satisfied
19+
- [ ] No requirements were silently dropped or deferred
20+
- [ ] Edge cases mentioned in the issue are handled
21+
- [ ] Scope creep is avoided — changes are limited to what was requested
22+
23+
**Notes:**
24+
<!-- List any requirements you could not fully address and why -->
25+
26+
---
27+
28+
## 2. Implementation Completeness
29+
30+
Confirm the implementation is production-ready.
31+
32+
- [ ] Code compiles without errors (`npm run build`)
33+
- [ ] No `TODO` or `FIXME` comments left in the changes
34+
- [ ] Error handling follows the SDK's [error standard](../../docs/error-standard.md)
35+
- [ ] Public APIs have JSDoc comments
36+
- [ ] No secret keys, seed phrases, or `.env` values are committed
37+
- [ ] Dependencies were not added without discussion (see [Dependency Review](../../docs/dependency-review.md))
38+
39+
**Modules changed:**
40+
<!-- List the files/modules you modified -->
41+
42+
**Notes:**
43+
<!-- Any design decisions or trade-offs worth mentioning -->
44+
45+
---
46+
47+
## 3. Testing Evidence
48+
49+
Provide concrete evidence that your changes work correctly.
50+
51+
- [ ] Unit tests added or updated for all behaviour changes
52+
- [ ] Bug fix includes a regression test
53+
- [ ] Tests pass locally (`npm test`)
54+
- [ ] Tests are isolated — no live network calls required
55+
- [ ] Edge cases and error paths are covered
56+
57+
**Test files added/modified:**
58+
<!-- List test files -->
59+
60+
**Test output summary:**
61+
```
62+
<paste `npm test` output summary here>
63+
```
64+
65+
---
66+
67+
## 4. CI Status
68+
69+
Confirm automated checks will pass.
70+
71+
- [ ] `npm run lint` passes with no errors
72+
- [ ] `npm test` passes with no failures
73+
- [ ] `npm run verify:pr` passes (recommended)
74+
- [ ] No circular dependency issues introduced
75+
76+
**Local verification output:**
77+
```
78+
<paste `npm run verify:pr` output here, or at minimum `npm run lint && npm test`>
79+
```
80+
81+
---
82+
83+
## 5. Documentation
84+
85+
Verify documentation is updated where needed.
86+
87+
- [ ] Public API changes are reflected in docs
88+
- [ ] README updated if usage patterns changed
89+
- [ ] Chelog entry added for user-facing changes (see [Changelog Policy](../../docs/changelog-policy.md))
90+
- [ ] Any new error codes added to the [error taxonomy](../../docs/public_error_taxonomy.md)
91+
92+
**Docs updated:**
93+
<!-- List any documentation files you modified -->
94+
95+
---
96+
97+
## 6. Known Limitations
98+
99+
Be honest about what your implementation does not cover.
100+
101+
- [ ] I have documented any known limitations in the PR description
102+
- [ ] I have identified follow-up work that may be needed
103+
- [ ] I have noted any performance considerations
104+
- [ ] I have flagged any areas where I am uncertain about the approach
105+
106+
**Limitations:**
107+
<!-- Describe known limitations, follow-ups, or areas of uncertainty -->
108+
109+
---
110+
111+
## 7. Final Confirmation
112+
113+
- [ ] I have reviewed my own PR diff objectively, as if I were the reviewer
114+
- [ ] I have verified no secrets or sensitive data are committed
115+
- [ ] I have confirmed the PR description explains **what** changed and **why**
116+
- [ ] I understand that a merged PR is **not** automatically payment-approved
117+
118+
---
119+
120+
## Submitting
121+
122+
1. Complete this form and attach it to your PR description or include it as a comment
123+
2. Run `npm run verify:pr` one final time before requesting review
124+
3. Request review from a maintainer
125+
126+
> **Remember:** This self-review is for your benefit. Taking 10 minutes to complete it
127+
> can save days of back-and-forth during review.

‎.github/pull_request_template.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Closes #
1616
- [ ] If the issue has a checklist file, I ran `npm run verify:pr -- --checklist .github/checklists/issue-<number>.md`
1717
- [ ] All automated checks passed (lint, circular deps, unit tests, build)
1818
- [ ] I confirmed each acceptance criterion above is satisfied
19+
- [ ] I completed the [Contributor Self-Review Form](../.github/checklists/contributor-self-review.template.md)
1920

2021
## Test plan
2122

‎CONTRIBUTING.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,21 @@ Before opening a PR, run through this list:
182182
- [ ] The PR references the related issue (e.g. `Closes #6`)
183183
- [ ] No `.env` or secret values are committed
184184
- [ ] **I have reviewed the [Contributor Security Checklist](#contributor-security-checklist) and verified my code introduces no secret leakage or insecure dependencies.**
185+
- [ ] **I have completed the [Contributor Self-Review Form](.github/checklists/contributor-self-review.template.md)**
186+
187+
## Contributor Self-Review
188+
189+
Before requesting review or expecting payment approval, complete the [Contributor Self-Review Form](.github/checklists/contributor-self-review.template.md). This helps you evaluate your work objectively and ensures nothing is missed.
190+
191+
The self-review covers:
192+
- Requirements review
193+
- Implementation completeness
194+
- Testing evidence
195+
- CI status
196+
- Documentation
197+
- Known limitations
198+
199+
> **Tip:** Copy the template to `.github/checklists/contributor-self-review-<issue-number>.md` and fill it in as you work on your contribution.
185200
186201
---
187202

0 commit comments

Comments
 (0)