code-review-checklist

Guide structured code reviews with checklists for bugs, security, and maintainability.

Updated Dec 10, 2024
One-click install
npx skills add https://github.com/melikhanmutlu/web_ar --skill code-review-checklist-melikhanmutlu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-review-checklist
Source: https://github.com/melikhanmutlu/web_ar/tree/main/skills/code-review-checklist
Command: npx skills add https://github.com/melikhanmutlu/web_ar --skill code-review-checklist-melikhanmutlu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Review teams often miss critical issues during code reviews, leading to defects, security gaps, and inconsistent coding standards. This skill provides structured guidance to conduct thorough, repeatable code reviews that improve overall code quality.

Core Features & Use Cases

  • Structured checklists for functionality, security, performance, maintainability, and testing.
  • Templates and examples for giving constructive feedback.
  • Guidance for scoping reviews, prioritizing issues, and ensuring documentation.
  • Best practices and recommended workflows to standardize reviews across teams.
  • Use Cases: during PR reviews, code audits, onboarding new engineers, and setting team standards.

Quick Start

Open a pull request, apply the provided code-review-checklist, and document findings before merging.

Frequently Asked Questions about code-review-checklist

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I structure a code review to catch bugs and security issues?

A code review checklist provides prebuilt criteria for functionality, quality, security, performance, tests, and documentation. It guides reviewers through a repeatable process to catch issues and ensure maintainable code before merging pull requests.

What should be included in a pull request review checklist?

A pull request review checklist should include criteria for functionality, security, performance, maintainability, and testing. It provides prebuilt templates and examples for constructive feedback, plus guidance on scoping reviews and prioritizing issues.

How do I write actionable feedback during a code review?

To write actionable feedback during a code review, use provided templates and examples for constructive feedback. These templates guide you in scoping reviews, prioritizing issues, and standardizing the feedback process across software engineering teams.

Can I use a code review checklist for onboarding new engineers?

Yes, you can use a code review checklist for onboarding new engineers. It provides structured criteria, best practices, and recommended workflows that help new team members understand coding standards and conduct thorough, repeatable reviews.

What's the best way to standardize code reviews across a software engineering team?

The best way to standardize code reviews across a software engineering team is to apply a structured checklist with prebuilt criteria and best practice workflows. This ensures consistent coding standards, reduces missed defects, and improves overall code quality.

Why do code review teams miss critical issues during pull requests?

Code review teams often miss critical issues during pull requests due to a lack of structured, repeatable processes. Without prebuilt criteria and checklists for security and functionality, defects and inconsistent coding standards easily slip through.