self-review

Review git branch diffs for logical errors, edge cases, and documentation freshness.

2.3k|331|Updated Jun 3, 2024
One-click install
npx skills add https://github.com/crbnos/carbon --skill self-review-crbnos
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: self-review
Source: https://github.com/crbnos/carbon/tree/main/.ai/skills/self-review
Command: npx skills add https://github.com/crbnos/carbon --skill self-review-crbnos

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill unit ensures the quality and maintainability of your code by providing a thorough review of your branch work before merging into the main branch.

Core Features & Use Cases

  • Code Quality Audit: Identifies potential bugs, logic errors, and code inefficiencies.
  • Documentation Freshness Check: Ensures that all relevant documentation is up-to-date with the latest code changes.
  • Use Case: Before opening or merging a PR, use this skill to review the full branch diff against main and ensure that your code meets the project's standards.

Quick Start

Run the 'self-review' skill on your branch to review your code changes and generate a report on issues and documentation updates.

Frequently Asked Questions about self-review

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

FAQPage Schema
How do I review code commits for logical errors before merging a branch?

To review code commits for logical errors before merging a branch, you can analyze the branch diff against main to detect bugs, identify missing edge cases, and resolve code inefficiencies.

How does a branch diff check for code maintainability and documentation freshness?

A branch diff check evaluates code maintainability by reviewing commits for inefficiencies, while simultaneously scanning the changes to ensure all relevant documentation is complete and up-to-date.

Can I use an automated code review to find missing edge cases in my software development process?

Yes, you can use an automated code review to find missing edge cases in your software development process by analyzing the full branch diff to pinpoint logical errors and potential bugs.

What is the best way to ensure code quality before opening a pull request?

The best way to ensure code quality before opening a pull request is to run a comprehensive review on your branch work to audit code logic, verify documentation freshness, and confirm overall maintainability.

Do I need a git diff to perform a quality assurance audit on my branch?

Yes, you need a git diff to perform a quality assurance audit on your branch, as generating a branch diff against the main branch is required to evaluate the commits and detect code inefficiencies.