1- Readable
Code Review Checklist:
- Logging
- Monitoring
- Scale
- Traceability
- Troubleshooting
- Reporting
- UX
- Incorrect problem definition
- Time management
- Ignoring other features.
- Focusing on today needs.
- Alerting
- Metrics
- Testing
- Deployment
- Code cleanup
- Latency
- No design review
- No customer review
- Concurrency
- Simple bugs
- Mutation
- Readability
- Naming
- Documentation (motivation)
- Audit
- Security
- Complex if-then logic
- Suspicious loop 'break'
- Negative logic
- Regexp - long input could cause issues.
- Nulls
- More than 3 arguments
- Line length
- Shared resources abuse
- Cache (think hard)
- Variable name length
- Commit message
- Squash if needed
- Build time change
- "Random" usage smell
- Open Close principle
- Code duplication
- OverComplexity (ex. Types where string is enough)
- UnderComplexity (ex. strings where type is required)
- Bulk test fail smell
- Backward compatibility
- Forward compatibility
- API no version
- Incorrect db type usage
- Adding indexes instead of search engine view
- Ignoring Failures
- Expecting feature would work
- Too verbose error handling
- Sensitive info in logs
- Missing "main" flow
- Feature toggle (if needed)
- Dependencies (collisions? new one?)
- Comments smell
- Dependent Teams
- Plural/Singular correctness
- Consistency with codebase conventions
- Revert implications
- Either simple MultiReturn or Single
- Time to understand code smell
No comments:
Post a Comment