File tree Expand file tree Collapse file tree 1 file changed +38
-0
lines changed
Expand file tree Collapse file tree 1 file changed +38
-0
lines changed Original file line number Diff line number Diff line change 1+ # Code Review Guidelines
2+
3+ ## Code Quality
4+
5+ - Logic errors and potential bugs
6+ - Error handling and edge cases
7+ - Code clarity and maintainability
8+ - Adherence to existing patterns in the codebase
9+ - ** Use existing utilities** - Search codebase before adding new helpers
10+ - ** Prefer ` ?? ` over ` || ` ** - Preserves zero/empty string as valid values
11+
12+ ## Architecture
13+
14+ - Consistency with existing architecture patterns
15+ - Breaking changes or backward compatibility issues
16+ - API contract changes
17+ - ** Deduplicate** - Move repeated code/types to shared files
18+ - ** Extract utilities** - Shared functions belong in utils packages
19+
20+ ## Testing
21+
22+ - Test coverage for new/modified code
23+ - Edge cases that should be tested
24+ - ** New utility functions need unit tests**
25+
26+ ## Performance
27+
28+ - Gas efficiency (for Solidity changes)
29+ - Unnecessary allocations or computations
30+
31+ ## Registry-Specific
32+
33+ - ** Warp ID format** - Must be ` {SYMBOL}/{label} ` (e.g., ` USDC/ethereum-arbitrum ` )
34+ - ** Address provenance** - Note source of address changes (monorepo PR, deployment tx)
35+ - ** Changeset required** - Include changeset for version bumps
36+ - ** YAML keys alphabetical** - ESLint enforces sorted keys
37+ - ** No Node.js in main src/** - Only ` src/fs/ ` can import Node.js modules
38+ - ** Deterministic ordering** - Sort arrays/maps before processing
You can’t perform that action at this time.
0 commit comments