跳到正文
cccskills
免费在 GitHub 公开

cc-api-contract

Run the API contract workflow for public interface changes, compatibility constraints, contract tests, documentation, and review.

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(1)

  • SKILL.md2.8 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

api-contract

Invoke as $cc-api-contract. The user request follows the skill mention.

API Contract Workflow

API contract request: $ARGUMENTS

Step 0 — CCEP Bootstrap

Command: api-contract (fixed for this workflow — do not infer from user text)

  1. Run: npx cc-codeconductor ccep profile api-contract --output json to get the phases and their roles.
  2. For each delegated phase, run: npx cc-codeconductor ccep compile --command api-contract --phase <phase-id> "$ARGUMENTS" --view prompt --output json
  3. After planner/intake JSON is available, run: npx cc-codeconductor ccep evaluate --command api-contract --input <planner.json> --output json. If stop is true, show questions or risks and wait for human input.
  4. Pass each subagent only the compiled prompt for its phase — never forward raw $ARGUMENTS to planners.

Step 0b — OpenSpec quality gates

If openspec status reports an active change folder:

  1. Run: npx cc-codeconductor openspec validate --output json
  2. Run: npx cc-codeconductor openspec analyze --output json
  3. If analyze stop is true or any finding is CRITICAL, stop. Do not delegate to implementer.
  4. Next command spelling on this runner: $cc-api-contract

Run the CLI as npx cc-codeconductor <same argv>.


Step 1 — Task Card validation (Task Coach role)

Adopt the task-coach role as defined in AGENTS.md.

The Task Card must classify the task as high risk by default and include the affected public interface, request/response examples, compatibility notes, versioning impact, consumer impact, contract tests, and docs acceptance criteria.

STOP here. Show the completed Task Card and wait for human confirmation.


Step 2 — Technical Plan (Architect role)

Adopt the architect role as defined in AGENTS.md.

Define the API contract, validation strategy, compatibility behavior, docs or OpenAPI changes, and reviewer blocking conditions.

STOP here. Show the Technical Plan and wait for explicit human approval.


Step 3 — Implementation (Implementer role)

Adopt the implementer role as defined in AGENTS.md.

Apply the minimal diff, preserve compatible behavior unless explicitly approved as breaking, and update only the planned files.


Step 4 — Contract Tests (Tester role)

Adopt the tester role as defined in AGENTS.md.

Add or update tests for request shape, response shape, status/error behavior, and backward compatibility.


Step 5 — Review (Reviewer role)

Adopt the reviewer role as defined in AGENTS.md.

Block on missing contract tests, undocumented breaking changes, or docs/OpenAPI drift.

Next

Run $cc-review on the diff before merging.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Use when adding monitoring, metrics, logging, or tracing to Spring AI or LLM integration code. Covers token tracking, latency measurement, cost estimation, and prompt/response logging. Use when user mentions AI monitoring, token costs, or LLM observability.

中文简介正在准备中。当前显示原文说明。

lgzarturo/springboot-course32026年10月17日 更新

android

免费

Provides expert knowledge for building modern native Android apps using Kotlin, Jetpack Compose, Material Design 3, MVI architecture, Hilt dependency injection, and Media3/ExoPlayer.

中文简介正在准备中。当前显示原文说明。

lgzarturo/springboot-course32026年10月17日 更新

Design, implement, review, and audit Android Jetpack Compose UI/UX for phone interfaces. Use when a request concerns concrete Compose layout, components, interaction, accessibility, or visual behavior. Do not activate for framework or dependency presence alone; non-UI Android work is excluded.

中文简介正在准备中。当前显示原文说明。

lgzarturo/springboot-course32026年10月17日 更新

Provides expert knowledge for designing, implementing, and managing REST API versioning strategies with deprecation workflows.

中文简介正在准备中。当前显示原文说明。

lgzarturo/springboot-course32026年10月17日 更新

astro

免费

Provides expert knowledge for building Astro 5+ sites with Islands Architecture, Content Collections, TypeScript, and performance-first rendering strategies.

中文简介正在准备中。当前显示原文说明。

lgzarturo/springboot-course32026年10月17日 更新

Audits token storage mechanisms to prevent XSS-based JWT theft.

中文简介正在准备中。当前显示原文说明。

lgzarturo/springboot-course32026年10月17日 更新

查看 lgzarturo 的全部技能

报告此技能的问题