code-review

Review code against implementation plans and quality standards.

Updated Dec 22, 2024

Search Tags:#testing #quality assurance #code review #security #software development #compliance

Ready to run

npx skills add https://github.com/lvstb/nix-config --skill code-review-lvstb

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: code-review
Source: https://github.com/lvstb/nix-config/tree/main/home/opencode/skills/code-review
Command: npx skills add https://github.com/lvstb/nix-config --skill code-review-lvstb

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the process of reviewing code against a defined plan and quality standards, identifying and classifying issues by severity to ensure code quality and adherence to requirements.

Core Features & Use Cases

Spec Compliance: Verifies that code meets all requirements outlined in the implementation plan.
Code Quality: Assesses readability, maintainability, error handling, and adherence to DRY principles.
Security Check: Performs a basic review for common security vulnerabilities like exposed secrets.
Use Case: Before merging a new feature branch, use this Skill to ensure all planned functionalities are implemented correctly, the code is clean, and no sensitive information has been accidentally committed.

Quick Start

Review the code in the current branch against the implementation plan.

Frequently Asked Questions about code-review

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

FAQPage Schema

How do I review code against an implementation plan and quality standards?▼

Reviewing code against an implementation plan requires checking spec compliance, code quality, and basic security vulnerabilities. This skill automates the process by classifying identified issues by severity and reporting findings in a standardized Markdown format.

What does automated code compliance checking cover for software development?▼

Automated code compliance checking covers spec compliance to verify planned functionalities, code quality to enforce DRY principles and error handling, and security checks to identify common vulnerabilities like exposed secrets before merging feature branches.

Can I use this code review skill to check for exposed secrets and security vulnerabilities?▼

Yes, you can use this code review skill to perform a basic security check for common vulnerabilities like exposed secrets. It assesses code alongside spec compliance and quality standards, reporting all identified security issues classified by severity.

How do I ensure spec compliance before merging a new feature branch?▼

To ensure spec compliance before merging a feature branch, review the code against your predefined implementation plan. This skill verifies that all planned functionalities are implemented correctly, the code is clean, and no sensitive information is committed.

Does this automated code review tool assess code readability and DRY principles?▼

Yes, this automated code review tool assesses code quality by checking readability, maintainability, error handling, and adherence to DRY principles. It operates alongside spec compliance and security checks to classify all findings by severity.