# 文档协作规则 本仓库是 AutoFlow 统一自动化测试平台(整合 D-Cloud + Robogo)的 Markdown 事实源。测试规范、测试用例、覆盖率报告、API 测试经验、Agent 任务和关键变更都应沉淀到仓库文档中,避免只停留在聊天记录、会议纪要或单个测试文件里。 ## 1. 修改测试代码 如果新增、删除或调整 UI、API、Flow、E2E、异常、边界或综合测试,必须检查是否需要更新: ```text test_cases/ docs/coverage/ history.md ``` 测试代码应遵循: ```text specs/AUTOMATION-SPEC.md specs/TEST-WRITING-SPEC.md ``` ## 2. 修改 Page Object 如果新增或重构页面对象、定位器、导航方法、业务动作、等待策略或 Mixin 能力,必须检查是否需要更新: ```text specs/PAGE-OBJECT-SPEC.md docs/PAGE_OBJECT_GUIDE.md history.md ``` 页面对象应优先封装业务动作,不应把复杂定位器和等待逻辑散落在测试用例中。 ## 3. 修改 API 测试 如果 API 测试的路径、Header、入参、出参、业务状态码、关键字段、错误响应或边界规则发生变化,必须检查是否需要更新: ```text specs/API-TEST-SPEC.md api_docs/ swagger/ test_cases/ history.md ``` API 测试应至少覆盖 HTTP 状态码、业务状态码和关键字段;仅做连通性验证时,需要在测试或文档中说明原因。 ## 4. 修改测试用例文档 如果需求、接口、页面流程、历史缺陷或自动化覆盖范围发生变化,必须检查是否需要更新: ```text test_cases/ docs/coverage/ ``` 测试用例文档应遵循: ```text specs/TEST-CASES-SPEC.md ``` ## 5. 修改覆盖率报告 如果模块自动化覆盖率、未覆盖清单、MeterSphere 对照表或优先级建议发生变化,必须更新对应报告: ```text docs/coverage/ ``` 覆盖率报告应区分: - 已自动化覆盖。 - 部分覆盖。 - 未覆盖。 - 功能待确认。 ## 6. 修改通用规范 如果测试目录、命名规则、pytest 标记、fixture 规则、Page Object 结构、API 断言策略、报告生成方式或文档结构发生变化,必须更新: ```text specs/ README.md history.md ``` 规范变化可能影响多个模块,应在提交说明中写明影响范围。 ## 7. 修改 Agent 任务 如果需要让 AI 或 Agent 执行一项可追踪任务,应在以下目录补充任务说明: ```text agent_tasks/ ``` Agent 任务应至少说明输入、输出、边界、验收标准、禁止事项和执行记录。 ## 8. 修改文档结构 如果新增目录、调整文档地图、调整任务路由或关键词路由,必须更新: ```text README.md history.md ``` 旧路径如果已被团队使用,应保留跳转说明或兼容索引。 ## 9. 提交前检查 提交前至少检查: - `README.md` 是否能路由到新增文档。 - 新增测试是否有对应 marker、模块目录和命名规则。 - API 测试是否覆盖业务状态码和关键字段。 - Page Object 是否封装了页面细节,测试用例是否保持业务可读。 - 测试用例、覆盖率和历史变更是否需要回写。 - 文档中是否出现真实账号、密码、token、cookie 或其他敏感信息。 ## 10. 业务工程联动 业务代码工程和本自动化测试工程应保持关联: - 业务需求或接口变更如果影响测试,应同步更新自动化测试和文档。 - 自动化测试发现的历史缺陷和回归风险,应回写到测试用例或覆盖率报告。 - AI 和 Agent 执行任务时,应优先读取本仓库文档,再修改测试代码。