review-clarity-naming-comment-intent

Community

Catch naming and comment clarity gaps in PRs pre-merge.

AuthorD3Hunter
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Unclear naming, inconsistent domain vocabulary, and low-quality code comments in behavior-changing pull requests create confusion for code consumers, increase maintenance overhead, and introduce contract mismatch risks that can lead to bugs or breaking changes post-merge.

Core Features & Use Cases

  • Static PR Diff Analysis: Reviews code changes without running build or test commands, focusing exclusively on naming clarity, comment intent, and public surface minimization.
  • Domain Vocabulary Consistency Checks: Flags instances where the same concept uses multiple names, or the same name has different meanings across code and interface surfaces.
  • Comment Intent Validation: Identifies comments that only restate code mechanics, are stale, or contradict current behavior, and flags missing rationale for security-sensitive or non-obvious logic.
  • Use Case: When merging a PR that adds new API endpoints, this skill catches ambiguous parameter names, endpoint paths that conflict with HTTP semantics, and missing side-effect documentation for public methods, preventing consumer confusion and integration issues.

Quick Start

Use this skill to review the diff for your current pull request for naming clarity, comment intent, and public surface minimization issues before merging.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: review-clarity-naming-comment-intent
Download link: https://github.com/D3Hunter/ai-engineer/archive/main.zip#review-clarity-naming-comment-intent

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 536,000+ vetted skills library on demand.