code-reviewer

Analyze code for quality, correctness, and security issues.

17.6k|2.0k|Updated Mar 17, 2023
One-click install
npx skills add https://github.com/camel-ai/camel --skill code-reviewer-camel-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-reviewer
Source: https://github.com/camel-ai/camel/tree/main/examples/toolkits/skill_toolkit_example/.camel/skills/code-reviewer
Command: npx skills add https://github.com/camel-ai/camel --skill code-reviewer-camel-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps developers perform thorough code reviews to improve quality, readability, and security, reducing bugs and maintenance costs.

Core Features & Use Cases

  • Correctness: identifies logic errors and runtime bugs.
  • Readability and Style: ensures clear code structure and adherence to conventions.
  • Performance and Security: spots inefficiencies and potential vulnerabilities.
  • Use Case: when reviewing a pull request, a teammate's patch, or a legacy module to ensure code quality before merge.

Quick Start

Use the code-reviewer to review the attached file 'main.py' and produce a structured report including Overall Assessment, Issues Found, Positive Aspects, and Recommendations.

Frequently Asked Questions about code-reviewer

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

FAQPage Schema
How do I automate code review for a pull request?

To automate code review for a pull request, you analyze the submitted code against best practices to extract logic errors, style issues, and security vulnerabilities, producing a structured markdown report with overall assessment and recommendations.

What does static analysis check for code quality and security?

Static analysis for code quality and security checks for correctness by identifying logic errors, ensures readability through clear structure and conventions, and spots performance inefficiencies and potential security vulnerabilities before merging.

Can I use an automated code reviewer for legacy code modules?

Yes, you can use an automated code reviewer for legacy code modules to perform thorough assessments, find runtime bugs, and receive improvement suggestions to ensure code quality and reduce maintenance costs.

How do I generate a structured code review report?

To generate a structured code review report, analyze the code file by category to extract issues, then compile the findings into a markdown format featuring Overall Assessment, Issues Found, Positive Aspects, and Recommendations.

What is the best way to review a teammate's patch for best practices?

The best way to review a teammate's patch for best practices is to analyze the code structure against conventions, spot potential vulnerabilities, and produce detailed improvement suggestions covering correctness and performance.

Does automated code review identify readability and style issues?

Yes, automated code review identifies readability and style issues by evaluating code structure, ensuring adherence to conventions, and providing structured feedback to improve clarity and reduce bugs.