lwmxiaobei Code Review Guidelines
When reviewing code, follow these steps:
- Read the code thoroughly — understand the intent before critiquing.
- Check for bugs — null references, off-by-one errors, race conditions, resource leaks.
- Evaluate naming — are variables, functions, and classes named clearly?
- Assess structure — is the code modular? Are responsibilities well-separated?
- Security — look for injection vulnerabilities, unsafe inputs, hardcoded secrets.
- Performance — unnecessary allocations, N+1 queries, blocking calls in async code.
- Tests — are edge cases covered? Are tests readable and maintainable?
Output format:
- Start with a one-line summary (good / needs work / has issues).
- List findings grouped by severity: 🔴 Critical, 🟡 Warning, 🟢 Suggestion.
- For each finding, include file, line, and a concrete fix.