How does this skill help with monorepo management?

It provides a standardized step-by-step procedure to update multiple packages (contracts, api, bot) in the correct order, followed by a global verification check.

Why is direct database access prohibited for the bot?

To maintain a clean separation of concerns, the skill enforces that consumers like bots must use the API layer, ensuring all data access follows the defined business logic and contracts.

What does a contract-first approach mean in this skill?

It means the API schema (the 'contract') must be defined and updated in the shared contracts package before any implementation logic is written in the API or consumer services.

Which verification commands are executed?

The skill runs pnpm build commands for the contracts, api, and bot filters, along with a general check command to ensure the entire system is valid after changes.

Contract-First API Workflow

Name: Contract-First API Workflow
Author: Hakuya5247

byHakuya5247

0•

API Development

Enforces a contract-first development cycle for API changes to ensure consistency across schemas, services, and documentation.

The Contract-First API Workflow skill is designed to standardize the way API changes are implemented within a monorepo environment. It mandates a strict sequence of operations: defining the schema in a shared contracts package, implementing the API, updating consumer services (like bots) without direct database access, and finally updating documentation. This approach minimizes integration errors, ensures type safety across the stack, and maintains a single source of truth for your API specifications, making it ideal for teams prioritizing architectural integrity and automated verification.

Key Features

01Synchronized documentation updates for structural changes

02Dependency enforcement preventing direct DB access from consumer layers

030 GitHub stars

04Strict contract-first schema definition in shared packages

05Standardized workflow for API additions and modifications

06Automated multi-package build verification with pnpm

Use Cases

01Enforcing architectural boundaries between backend services and UI/bot consumers

02Adding new endpoints to a TypeScript monorepo with type-safe contracts

03Refactoring existing API structures while ensuring consumer compatibility

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add hakuya5247/yomicord contract-first-api-change

For use in Claude.ai and ChatGPT

Download Skill