review-naming-api

Enforce naming and API-design hygiene for Pinot's public surface.

6.1k|1.5k|Updated May 19, 2014
One-click install
npx skills add https://github.com/apache/pinot --skill review-naming-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-naming-api
Source: https://github.com/apache/pinot/tree/main/.claude/skills/review-naming-api
Command: npx skills add https://github.com/apache/pinot --skill review-naming-api

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about review-naming-api

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

FAQPage Schema
How do I enforce public API naming consistency during code reviews?

To enforce public API naming consistency during code reviews, analyze pull request diffs to detect inconsistent public API names, SPI methods, and REST fields. This ensures new public classes follow established naming conventions and API design hygiene.

How do I check Javadoc coverage on new public classes in a PR?

Checking Javadoc coverage on new public classes involves scanning pull request diffs to verify that all newly introduced public APIs have Javadoc. It also ensures inline fully-qualified class names are avoided to maintain clean code.

What is public API design hygiene for REST endpoints and JSON fields?

Public API design hygiene for REST endpoints and JSON fields is the practice of maintaining consistent naming conventions and avoiding inline FQCNs across the public surface. It prevents inconsistencies from reaching production by enforcing standards during PR reviews.

Can I use automated checks to detect inconsistent SPI method names in code diffs?

Yes, you can use automated checks to detect inconsistent SPI method names in code diffs. By focusing on the public surface of a project, these checks provide actionable guidance to enforce naming hygiene before changes are merged.

What's the best way to avoid inline fully-qualified class names in public APIs?

The best way to avoid inline fully-qualified class names in public APIs is to review code diffs for the public surface and enforce API design hygiene rules. This catches FQCN usage and ensures consistent naming before production deployment.