OpenParable
Skip to content
← Back to skills

Review Naming API

Testing & Quality
review-naming-api

Review Naming API is an Agent Skill for testing & quality published in the apache/pinot repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

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.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/apache/pinot/blob/HEAD/.claude/skills/review-naming-api/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/review-naming-api, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Skill: review-naming-api

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