style-review

Analyzes code and documentation diffs for readability and idiomatic style improvements.

2|Updated May 18, 2022
One-click install
npx skills add https://github.com/alexfalkowski/bin --skill style-review-alexfalkowski
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: style-review
Source: https://github.com/alexfalkowski/bin/tree/main/skills/style-review
Command: npx skills add https://github.com/alexfalkowski/bin --skill style-review-alexfalkowski

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill addresses the friction of providing feedback on code that is functionally correct but lacks readability, idiomatic consistency, or professional polish, preventing unnecessary back-and-forth on minor stylistic choices.

Core Features & Use Cases

  • Non-blocking Polish: Provides suggestions for readability, naming, and local consistency without flagging them as critical bugs or security issues.
  • Context-Aware Review: Leverages language-specific standards to ensure suggestions align with established patterns for Go, Ruby, and Shell.
  • Use Case: Use this during a pull request review to suggest minor refactors, such as inlining a redundant one-line helper or improving variable naming, without stalling the merge process.

Quick Start

Invoke the style-review skill to analyze the current diff for readability improvements and idiomatic polish.

Frequently Asked Questions about style-review

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

FAQPage Schema
How do I provide non-blocking code review feedback for readability improvements?

Non-blocking code review feedback for readability improvements separates stylistic notes from critical findings, suggesting idiomatic cleanup and naming polish without flagging them as merge-blocking bugs. This prevents unnecessary friction on minor refactoring choices.

How do I suggest idiomatic refactoring during a pull request without stalling the merge?

Suggesting idiomatic refactoring during a pull request without stalling merges requires providing stylistic feedback as non-blocking notes. You can recommend local consistency improvements and minor structural cleanups that align with language-specific standards.

Does code review style feedback work with Go, Ruby, and Shell standards?

Code review style feedback works with Go, Ruby, and Shell standards by leveraging context-aware analysis to ensure suggestions align with established patterns and idiomatic conventions specific to those languages.

What is the best way to separate style notes from critical functional findings in code reviews?

The best way to separate style notes from critical functional findings in code reviews is to maintain a clear distinction between non-blocking stylistic feedback and structural issues, ensuring readability suggestions do not interfere with critical bug tracking.

What is non-blocking stylistic feedback for source code?

Non-blocking stylistic feedback for source code provides suggestions for readability, naming, and local consistency without flagging them as critical bugs or security issues, preventing unnecessary back-and-forth on minor stylistic choices during reviews.