Skip to main content
提交 PR 前,请用这份清单做最后检查,确认变更范围清楚、实现符合契约、验证结果可以复现,并且最终差异便于审查。 这里只列出所有 PR 都需要关注的合入条件。组件实现、测试命令和文档格式等细节以各专项指南为准。只需检查与本次变更有关的项目;如果某项必要检查未能完成,请在 PR 中说明原因和可能带来的风险。

变更范围与说明

  • PR 只围绕一个明确问题展开,不夹带无关的重构、格式调整、依赖升级或生成文件。
  • PR 描述中说明了要解决的问题、负责该行为的组件、关键设计取舍和用户可见变化,也列出了本次不处理的内容。
  • 分支已更新到目标分支的最新提交;如有依赖或堆叠 PR,已注明相关链接和合入顺序。
有关分支管理、提交信息和 PR 描述的具体要求,请参阅通用贡献流程

契约、兼容性与安全

  • 本次涉及的 Benchmark、Harness、Environment、Recipe 或 Analyzer 已按照相应集成指南完成检查。
  • 如果变更涉及公开配置、受支持的组件组合、持久化格式或生命周期,已处理相关的兼容性、迁移、错误分类和资源清理问题,并明确说明已知限制。
  • 差异中不包含凭证、个人信息或内部基础设施细节,也没有削弱由 Environment 强制执行的安全边界。数据集、Model 输出、完整结果目录、缓存等大型文件或生成产物同样没有提交。
各组件的完成标准见以下集成指南:BenchmarkHarnessEnvironmentRecipeAnalyzer

验证结果与证据

  • 已完成本次变更所需的针对性检查,并在请求审查前通过当前 CI 使用的完整 pre-commit 检查。
  • 如果变更涉及组件注册、配置或任务执行,已检查组件发现结果、生成的配置文档或合并后的配置,并至少运行一个有代表性的真实任务。
  • 已根据变更风险检查相关失败路径,并验证显式配置与默认值的覆盖关系、重试、超时、取消、兼容性和资源清理行为。
  • PR 中记录了准确且脱敏的命令、相关版本、配置和关键结果;对于未执行的必要检查,也写明了原因和风险。
代码仓库当前采用的检查、命令和证据记录方式见测试与验证

文档与最终差异

  • 如果变更影响公开行为,已在同一 PR 中更新相应的中英文文档。
  • 如果页面有新增、移动或删除,已同步更新中英文目录、docs/docs.json、引用这些页面的链接以及必要的重定向。
  • 文档变更已通过 mint broken-linksmint validate;涉及导航、表格、组件或响应式布局时,也已预览实际效果。
  • 最终差异中没有冲突标记、意外的格式改动、调试输出、过期注释或无关内容,并且实现、文档和验证证据相互一致。
有关页面归属、本地化、导航、公开内容边界和 Mintlify 的具体规则,请参阅文档贡献