review-naming-api

Review Apache Pinot diffs for naming, API design, and public-surface hygiene — method and class names; REST JSON field names; SPI method names; enum constant names (permanent); consistency with existing patterns; fully-qualified class names inline (disallowed); Javadoc on new public classes. Trigger keywords — public API, SPI, REST, @JsonProperty, enum name, class rename, method rename, Javadoc.

Jump to install

Repository: apache/pinot
Last source activity: May 12, 2026 at 17:15
Detected SKILL.md language: English
Stars: 6,128
Forks: 1,503

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

A direct command skips the review prompt. Inspect the source before running it.

npx skills add https://github.com/apache/pinot --skill review-naming-api

The command stays on one line. Scroll horizontally to inspect it before copying.

Prefer a local copy? Download the files currently available to SkillsMP.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

SKILL.md

Source instructions · Read-only preview

Back to search Back to installation

bench-compare

Run a Pinot JMH benchmark twice — once on a baseline commit, once with the current changes — and report both sets of results side by side. Uses a git worktree so the user's working tree is never disturbed.

2026-05-12

flaky-analyze

Pull recent GitHub Actions failures for a Pinot test class and analyze whether they share a root cause. Uses the gh CLI. Surfaces stack traces, failure patterns, and a candidate hypothesis — does not auto-fix.

2026-05-12

precommit

Run Pinot's mandatory pre-commit checks (spotless, license, checkstyle) and compiler warning checks on only the modules affected by the current diff. Auto-fixes what it can, reports what it can't.

2026-05-12

View all from this repository

name	review-naming-api
description	Review Apache Pinot diffs for naming, API design, and public-surface hygiene — method and class names; REST JSON field names; SPI method names; enum constant names (permanent); consistency with existing patterns; fully-qualified class names inline (disallowed); Javadoc on new public classes. Trigger keywords — public API, SPI, REST, @JsonProperty, enum name, class rename, method rename, Javadoc.
domain	kb/code-review-principles.md#7-naming--api-design
triggers	["diff adds or renames public classes/methods/fields","diff adds new enum constants or DataType values","diff adds a new REST endpoint, resource, or JSON field","diff touches Javadoc on public-API classes"]
license	Apache-2.0

Skill: review-naming-api

Procedure: see kb/skills/review-naming-api.md. Read it first, then follow it.

review-naming-api

Source facts

Install options

Review the source files

More from this repository

Skill: review-naming-api

Skill: review-naming-api

More from this repository