requesting-code-review - Requesting Code Review
requesting-code-review
Requesting Code Review
Community Development
Description
Best practices for requesting code reviews, helping reviewers efficiently complete reviews
Use Cases
- Submit PR and request review
- Prepare context for reviewers
- Guide reviewers on focus areas
- Reduce cognitive load for reviewers
- Speed up review process
Core Capabilities
- PR Description: Clear change explanation
- Context Provision: Background info and design decisions
- Review Guidance: Point out areas needing attention
- Test Instructions: How to verify changes
Example
I'm submitting a PR for order system refactoring, please help:1. Write clear PR description2. List main change points3. Explain reasons for design decisions4. Provide test verification steps5. Point out code needing focused reviewNotes
- Keep PR size manageable (suggest < 400 lines)
- Self-review first
- Provide enough context
- Clarify review urgency
Applicable Roles
Developer