Skills
.Work. You
Rest

review-naming-api

Official

Ensure public API naming stays clean and consistent.

Software Engineering#design#api#review#naming#public-api#javadoc
Authorapache
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Review and enforce naming and API-design hygiene for Pinot's public surface, catching inconsistencies before they reach production.

Core Features & Use Cases

  • Detect inconsistent public API names, SPI method names, and REST/JSON field naming.
  • Enforce Javadoc presence on new public classes and avoid inline fully-qualified names.
  • Provide actionable guidance during code reviews of diffs and PRs.

Quick Start

Review the latest pull request diff focusing on public API names, REST field names, and Javadoc coverage to enforce naming and API-design hygiene.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 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-naming-api
Download link: https://github.com/apache/pinot/archive/main.zip#review-naming-api

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 471,000+ vetted skills library on demand.