roddsrod/code-review-rules icon
public
Published on 4/29/2025
Code Review Rules

Code Review Rules

Rules
## Build & Development Commands - Ensure commands or scripts are idempotent where possible.
## Testing Guidelines - Encourage tests for any added logic, especially for edge cases. - Flag missing test coverage for critical paths.
## Code Style & Guidelines  - Flag repetition or deep nesting — suggest modularization. - Recommend meaningful names over generic ones (`data1`, `x`, etc.). - Highlight magic numbers or hardcoded values and suggest named constants.
## Documentation Guidelines  - Suggest README or inline documentation updates when functionality changes. - Encourage comments only where necessary to clarify intent or edge cases.