skills.rest
cdcoonce
cdcoonceCOMMUNITY
Explore all skills by this author →
GitHub

code-review

Analyzes Python, Markdown, and Mermaid files for code quality issues and applies automated fixes.

Updated Aug 15, 2024
Search Tags:#automation#quality assurance#code review#markdown#python#linter
One-click install
npx skills add https://github.com/cdcoonce/Portfolio_Website --skill code-review-cdcoonce
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-review
Source: https://github.com/cdcoonce/Portfolio_Website/tree/main/.claude/skills/code-review
Command: npx skills add https://github.com/cdcoonce/Portfolio_Website --skill code-review-cdcoonce

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires ruff, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of reviewing code for quality, style, and potential errors, ensuring higher standards and reducing manual review time.

Core Features & Use Cases

  • Comprehensive Analysis: Analyzes Python, Markdown, and Mermaid code for various issues including PEP8 violations, complexity, broken links, and syntax errors.
  • Automated Fixes: Suggests and can apply fixes for many identified issues.
  • Use Case: Before merging a new feature, use this Skill to automatically check the Python code for PEP8 compliance, identify any unused variables, and validate that the README's Markdown is correctly formatted and free of broken links.

Quick Start

Use the code-review skill to analyze the Python file 'src/main.py'.

Frequently Asked Questions about code-review

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

FAQPage Schema
How do I automate PEP8 compliance checks for Python code before merging?▼

You can automate PEP8 compliance checks by running an AI-powered code review on your Python files. This process identifies PEP8 violations, unused variables, and type hint issues, then offers automated fixes to ensure code quality before merging.

What is the best way to find broken links and syntax errors in Markdown and Mermaid files?▼

The best way to find broken links and syntax errors is to perform an automated code quality analysis on Markdown and Mermaid files. This review detects formatting issues, broken links, and Mermaid syntax errors, and can apply automated fixes.

Does this automated code review require installing ruff?▼

Yes, this automated code review requires the ruff dependency to be installed in your environment. Ruff functions as the underlying linter to analyze Python code for complexity, unused code, and PEP8 violations.

Can I automatically fix docstring problems and type hint issues during a code review?▼

Yes, you can automatically fix docstring problems and type hint issues during a code review. The analysis identifies these issues across your Python files and offers to apply automated fixes directly.

How does AI code review handle runtime errors and code complexity?▼

AI code review handles runtime errors and code complexity by analyzing Python files to detect potential runtime issues and calculate complexity metrics. It identifies these problems and suggests automated fixes to improve overall code quality.

Related Skills

Explore More Software Engineering Skills→
y1feng200156y1feng200156
33

lint-python

Check Python code quality and style with the Ruff linter.

Community
Intermediate
VidyaBodepudiVidyaBodepudi
2

finishing-a-development-branch

Completes final verification, cleanup, and review of a development branch before merge or PR.

Community
Intermediate
tygwantygwan
1

quality-gate

Automate quality validation at pre-commit, pre-merge, pre-release, and post-release CI gates.

Community
Advanced
inbharataiinbharatai
22

code-reviewer

Analyzes code for bugs, security vulnerabilities, performance bottlenecks, and style violations.

Community
Advanced