What problem does it solve?
Ineffective code reviews miss bugs, allow poor design, and provide unhelpful feedback, leading to lower code quality and developer frustration. This skill provides comprehensive guidelines for what to look for, how to write constructive comments, and best practices for both reviewers and authors.
Core Features & Use Cases
- Review Checklist: A detailed checklist covering correctness, design quality, testing coverage, readability, and performance.
- Constructive Feedback: Guidance on how to write clear, specific, and actionable comments, distinguishing between nits, suggestions, and critical issues.
- Response Guidelines: Best practices for authors to effectively address feedback, ask clarifying questions, and propose alternative solutions.
- Use Case: Before submitting a pull request, use this skill to self-review your code against best practices, ensuring it meets quality standards and anticipating potential reviewer comments.
- Use Case: As a reviewer, use the provided templates to give structured and helpful feedback, accelerating the review process and improving code quality.
Quick Start
This is a knowledge skill, auto-activated by relevant keywords.
To get guidance on code review, simply ask:
"What should I look for when reviewing a pull request?"
"How do I write a constructive code review comment?"