This guide aims to:
- Provide a systematic and actionable checklist for Rust code reviews.
- Supplement automated checks by tools such as compilers, rustfmt, and clippy.
- Help reviewers identify key issues including:
- Memory safety issues not detectable by the compiler.
- Concurrency safety hazards.
- Business logic defects.
- Performance bottlenecks.
- Maintainability issues.
- Information security risks.
This guide is applicable to:
- Code reviewers: Provides comprehensive inspection dimensions and specific verification methods.
- Code submitters: Understands review concerns and performs preliminary self-checks on code quality.
- Project leaders: A reference for establishing team code review standards.
- AI Automated Code Review Tool: Establishing Reference Standards for Reviewing Rust Code
The difference between this guide and the "Rust Coding Guidelines":
- Aimed at code reviewers rather than developers.
- Focuses on issues that are difficult for compilers and static analysis tools to detect.
- Provides specific inspection methods and examples.