api-reviewer

Review API design against Hex1b conventions for accessibility and documentation.

173|17|Updated Dec 6, 2025
One-click install
npx skills add https://github.com/mitchdenny/hex1b --skill api-reviewer-mitchdenny
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-reviewer
Source: https://github.com/mitchdenny/hex1b/tree/main/.github/skills/api-reviewer
Command: npx skills add https://github.com/mitchdenny/hex1b --skill api-reviewer-mitchdenny

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill standardizes the review of API design within the Hex1b codebase, guiding decisions about public exposure, accessibility modifiers, and conformance to project conventions.

Core Features & Use Cases

  • Establish a consistent framework for evaluating public vs internal API surfaces, naming, and documentation.
  • Provide a decision framework and review questions to ensure alignment with Hex1b conventions.
  • Support code reviews by highlighting best practices for accessibility, extension points, and API stability.

Quick Start

Review a PR that adds or changes an API surface and apply the reviewer framework to assess accessibility, naming, and documentation alignment.

Frequently Asked Questions about api-reviewer

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

FAQPage Schema
How do I review API design for public vs internal exposure in a codebase?

Reviewing API design for public versus internal exposure involves applying a decision framework to assess access modifiers, naming consistency, and documentation standards to ensure APIs conform to project conventions.

What should I check when reviewing public APIs in pull requests?

When reviewing public APIs in pull requests, check accessibility modifiers, extension points, API stability, naming consistency, and documentation quality to verify conformance with established project conventions.

When do I need to apply an API design review framework?

You need to apply an API design review framework during code reviews, design discussions, and pull requests where API surfaces, access modifiers, or documentation quality are modified or introduced.

What's the best way to standardize API accessibility and naming conventions across a codebase?

The best way to standardize API accessibility and naming conventions is to establish a consistent evaluation framework covering public versus internal surfaces, extension points, and documentation requirements.

Can I use a review framework to assess API stability and extension points?

Yes, you can use an API review framework to assess API stability and extension points by highlighting best practices for accessibility and evaluating whether the API surface aligns with project conventions.