Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

贡献流程

开始工作

  1. 更新远端引用并从最新 origin/main 创建 codex/<description> 分支。
  2. 确认工作树没有混入其他任务的修改。
  3. 大功能先明确产品边界、非目标和验收标准。
  4. 数据库变化先设计 migration 的升级、前向修复和兼容路径。

实现要求

  • 保持 PR 单一目的,不提前实现后续阶段。
  • 只暂存本次任务的文件。
  • 修改行为时同步测试和开发手册。
  • 新增依赖必须说明用途,关闭不需要的默认 feature。
  • 不提交 .env、数据库数据目录、构建产物或文档输出。

Pull request

PR 描述至少包括:

  • 改了什么以及为什么;
  • 对开发者或调用方的影响;
  • migration、兼容窗口和前向修复方式;
  • 安全边界与明确非目标;
  • 实际运行的验证命令。

默认创建 Draft PR。只有本地检查和 GitHub CI 全部成功、PR 可合并且文档已同步 时,才能转为 Ready。