|
1 | 1 | ## Description |
2 | 2 |
|
3 | | -<!-- Provide a brief description of the changes in this PR --> |
| 3 | +<!-- Brief description of changes --> |
4 | 4 |
|
5 | 5 | ## Related Issue |
6 | 6 |
|
7 | | -<!-- Link to the Linear ticket this PR addresses --> |
8 | | -Closes ENG-XXXX |
9 | | - |
10 | | -## Type of Change |
11 | | - |
12 | | -- [ ] Bug fix (non-breaking change that fixes an issue) |
13 | | -- [ ] New feature (non-breaking change that adds functionality) |
14 | | -- [ ] Breaking change (fix or feature that would cause existing functionality to change) |
15 | | -- [ ] Refactoring (no functional changes) |
16 | | -- [ ] Gas optimization |
17 | | -- [ ] Documentation update |
18 | | -- [ ] CI/CD or tooling changes |
19 | | - |
20 | | -## Changes Made |
21 | | - |
22 | | -<!-- List the key changes made in this PR --> |
23 | | - |
24 | | -- |
| 7 | +<!-- Link to Linear issue: Closes ENG-XXX --> |
25 | 8 |
|
26 | 9 | ## Testing |
27 | 10 |
|
28 | | -<!-- Describe the testing performed --> |
29 | | - |
30 | | -- [ ] Unit tests pass (`forge test`) |
31 | | -- [ ] Integration tests pass (if applicable) |
32 | | -- [ ] Fuzz tests pass (if applicable) |
33 | | -- [ ] Fork tests pass (if applicable) |
34 | | -- [ ] New tests added for new functionality |
35 | | -- [ ] Edge cases tested |
36 | | - |
37 | | -## Security Checklist |
38 | | - |
39 | | -<!-- ⚠️ CRITICAL: Smart contract security review --> |
40 | | - |
41 | | -- [ ] No reentrancy vulnerabilities |
42 | | -- [ ] Integer overflow/underflow handled (or using Solidity 0.8+) |
43 | | -- [ ] Access control is correct |
44 | | -- [ ] External calls are safe (checks-effects-interactions pattern) |
45 | | -- [ ] No front-running vulnerabilities |
46 | | -- [ ] No oracle manipulation risks |
47 | | -- [ ] Proper input validation |
48 | | -- [ ] Events emitted for state changes |
49 | | -- [ ] No hardcoded addresses (unless intentional) |
50 | | -- [ ] Upgrade safety considered (if upgradeable) |
51 | | - |
52 | | -## Gas Considerations |
53 | | - |
54 | | -- [ ] Gas usage is reasonable |
55 | | -- [ ] No unnecessary storage reads/writes |
56 | | -- [ ] Loops are bounded |
57 | | -- [ ] Batch operations considered where applicable |
58 | | - |
59 | | -## Solidity-Specific Checklist |
60 | | - |
61 | | -- [ ] Visibility modifiers are correct |
62 | | -- [ ] State mutability is correct (view/pure where applicable) |
63 | | -- [ ] NatSpec documentation added for public/external functions |
64 | | -- [ ] Error messages are descriptive |
65 | | -- [ ] Custom errors used where appropriate |
66 | | -- [ ] No compiler warnings |
67 | | - |
68 | | -## Code Quality |
69 | | - |
70 | | -- [ ] Code follows the project's style guidelines |
71 | | -- [ ] Self-review completed |
72 | | -- [ ] Comments added for complex logic |
73 | | -- [ ] No debug/console.log statements |
74 | | - |
75 | | -## Documentation |
76 | | - |
77 | | -- [ ] README updated (if needed) |
78 | | -- [ ] NatSpec comments added |
79 | | -- [ ] CHANGELOG updated (if applicable) |
80 | | -- [ ] Interface documentation updated (if applicable) |
81 | | - |
82 | | -## Pre-Submit Checklist |
83 | | - |
84 | | -- [ ] `forge fmt --check` passes |
85 | | -- [ ] `forge build` succeeds without warnings |
86 | | -- [ ] All CI checks pass |
87 | | -- [ ] Branch is up to date with main |
88 | | - |
89 | | -## Deployment Considerations |
90 | | - |
91 | | -<!-- If this PR affects deployed contracts --> |
92 | | - |
93 | | -- [ ] Migration plan documented (if needed) |
94 | | -- [ ] Backwards compatibility verified |
95 | | -- [ ] Upgrade path tested (if applicable) |
96 | | - |
97 | | -## Additional Notes |
98 | | - |
99 | | -<!-- Any additional context, screenshots, or information for reviewers --> |
100 | | - |
| 11 | +- [ ] Tests pass locally |
| 12 | +- [ ] New tests added (if applicable) |
0 commit comments