SuperAPI AI 工具集

synthesis-code-integration

编程与开发

查看项目

更新于 10-22 16:15

技能介绍

用途

本技能面向通过合成编码(synthesis coding)构建的项目,定义了多人贡献代码时的集成模式。与标准开源合并工作流不同,合成编码项目的集成需要更谨慎的 adopt-and-adapt(采用并适配)方法,因为贡献者基于已移动的代码库构建,直接合并可能导致问题。

主要能力

  • 绑定规则:默认采用并适配,从不盲目合并;从当前 main 分支创建新分支,选择性引入更改并在进入 main 前修复问题。
  • 零可接受失败:所有测试必须通过,所有 lint 必须干净,包括非贡献者导致的失败也需在同一分支修复。
  • 四道关卡:每个贡献在集成前需通过完整性、安全、架构和项目特定标准(Gates 1-4)。
  • 分支卫生:禁止将另一个长期分支合并到 PR 分支;每次 cherry-pick 后检查静默回退并运行完整测试套件;禁止强制推送 main 到暂存分支。
  • 压缩合并检查:每次压缩合并前运行 PR 清单检查,且不为未在目标分支代码中找到的功能写变更日志条目。
  • 配置升级保护:对关键配置值(如 effort level、token 预算、模型、重试次数)的每次有意升级,需用测试解释其重要性。
  • 基于代码的沟通:技术回复需基于代码,区分观察与结论,不知道时明确说明。
  • 贡献者署名:使用 Co-authored-by trailers 匹配集成强度。
  • 生产部署:始终需要明确的人工批准。

使用方式

技能包含参考文档,按需阅读:

  • references/pattern-and-roles.md:核心问题、adopt-and-adapt 模式、角色和贡献工作流。
  • references/review-gates.md:零可接受失败原则、Gates 1-4、约定审查清单和配置回归保护。
  • references/communication.md:反馈原则、基于代码的回复、集成审查文档。
  • references/integration-options.md:贡献者署名、多 PR 排序、选择性文件检出和集成强度的四个阶段。
  • references/branches-and-cherry-picks.md:PR 分支卫生、cherry-pick 后回归检查、旧分支基线和暂存分支管理。
  • references/squash-and-changelog.md:压缩合并前的 PR 清单检查和变更日志验证。
  • references/lessons.md:反模式和教训。
  • references/coverage-map.md:1.3.1 文本各部分的位置。

集成过程分为四个步骤:

  1. 评估:获取分支并审查差异,识别贡献内容、更改和假设;检查 main 移动距离和敏感区域(认证、安全、数据模型、用户界面文本)。
  2. 审查:根据项目质量关卡评估,产出书面反馈,包括优点、必须更改(安全问题、功能破坏、标准违反)和建议更改(代码质量、性能、架构)。
  3. 集成(采用并适配):从当前 main 创建新分支,选择性引入更改(逐文件、逐函数),在集成过程中修复问题,测试集成结果(运行完整测试套件和手动测试),压缩合并到 main 并使用贡献者署名,同步镜像/分支。
  4. 沟通:与贡献者分享集成审查,解释更改内容和原因,认可贡献价值,记录应加入贡献者指南的教训。

适用场景

适用于多人为合成编码项目贡献代码的场景,特别是需要确保集成质量、维护项目标准、避免合并冲突和回归的团队协作环境。

限制

资料未提供具体实施工具或自动化脚本,需依赖人工执行规则和流程。部分参考文件内容未在资料中详细展开。