agentleFS
comkocscomkocs/md-workflow/.agents/skills/contract-and-test-infra/SKILL.md

contract-and-test-infra

Skill3 starsChanged 8 days agoApache-2.0View on GitHub

当后端模块做完要交前端、前端开始对接或对接估时明显超预期时使用:按九步补齐消费者、状态复位、可读拒因、机器人全流程场景、契约只追加字段、常量进运行时配置和假传输层回放,不把测试链缺口推给前后端联调。

The file

Files
SKILL.md

这个 skill 是干什么的(人话)

后端做完要交给前端、或者对接比预想慢很多时,用这个 skill 先把接口约定和测试底子补齐。它要求每个模块有真实的调用方、卡住的状态能复位、每种拒绝都有看得懂的原因,并有一条能自动跑完的完整流程。不用它,前后端对接会反复卡在缺字段、测试卡死和说不清的报错上,工期成倍拉长。

分类

分类:单独装即可用

用前填这几个名字

  • {{接口契约名}}:正文说「协议」「帧」「帧格式」「协议号」的地方,换成你们前后端之间的接口契约;例:api/openapi.yaml
  • {{测试复位命令}}:正文第 3 步说「复位命令」的地方填它,只清授权的测试数据;例:python manage.py reset_test_state --account <测试账号>
  • {{端到端场景命令}}:正文第 5 步说「机器人场景」的地方填它,即自动走完一条完整业务流程的脚本;例:npm run e2e -- <模块名>
  • {{运行时配置表}}:正文第 8 步说「冷配置」的地方填它,即不重启就能改的配置;例:config/runtime.json。程序参数一律进此表,改值只改表、不改代码、不重发前后端;表带改动留痕(谁、何时、旧值→新值)与生效版本,运行记录写实际用值;可能再改的数收为具名常量与单一入口,禁止消费端各自内联;规则逻辑变更仍改代码。
  • {{回放录制目录}}:正文第 9 步说「录制帧」的存放处填它,假传输层从这里读;例:tests/replays/

什么时候用

  • 后端模块做完,准备交给前端对接。
  • 前端开始对接某个后端模块。
  • 对接或联调估时明显超出预期,要找根因。
  • 接口契约要加字段,或要新增不重启就能改的常量。
  • 要给客户端搭假传输层回放或端到端自动化场景。

步骤

  1. 对照「用前填这几个名字」一节,把正文里的对应说法换成你们的实值来理解。
  2. 读本目录 references/contract-and-test-infra.md 照做。

正文提到的宪法闸号、「来源项目」旧例和「角色与任务模板」说法出自 md-workflow 全套;单独使用时照步骤的意思做,这些引用可跳过或换成你们自己的做法。

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.