GitHub 协作
GitHub 与 Pull Request 流程
团队修改手册和代码时使用的分支、Commit、PR 和 Review 规则。
基本规则
所有文档和代码修改必须通过 GitHub Pull Request 完成,禁止直接修改 main 分支。
分支命名
建议格式:
docs/修改内容
fix/问题说明
feature/功能说明
codex/任务说明示例:
docs/update-sop-closing-store
docs/add-codex-task-template
fix/sidebar-navigation
codex/refactor-handbook-structureCommit 规范
建议格式:
docs: 更新开店 SOP
fix: 修复导航目录错误
chore: 调整 Fumadocs 配置
codex: 根据任务更新产品手册如果由 Codex 辅助完成,可以写:
docs: update onboarding guide with Codex assistancePR 必填内容
## 修改目的
说明为什么要做这次修改。
## 修改范围
- [ ] 文档内容
- [ ] 页面结构
- [ ] 配置文件
- [ ] 样式组件
- [ ] Codex 执行规则
## 主要修改内容
1.
2.
3.
## 预览链接
填写 Vercel Preview URL。
## 检查清单
- [ ] 内容表达清楚
- [ ] 没有泄露敏感信息
- [ ] 页面可以正常打开
- [ ] 导航目录正常
- [ ] 已经本地 build 或通过 Vercel Preview
- [ ] 如由 Codex 修改,已经人工检查过
## 是否由 Codex 辅助
- [ ] 是
- [ ] 否
如是,请说明 Codex 执行的任务。CODEOWNERS 建议
/content/docs/sop/ @负责人A
/content/docs/product/ @负责人B
/content/docs/tech/ @负责人C
/content/docs/codex/ @负责人D
/content/docs/decisions/ @负责人A @负责人Bmain 分支保护
建议开启:
- 禁止直接 push
main。 - 必须通过 Pull Request 合并。
- 至少 1 人 Review。
- 关键目录需要 CODEOWNERS Review。
- Vercel Preview 或 Build 通过后才能合并。
- 禁止未解决评论直接合并。
- 保留线性历史,方便追踪。
检查清单
- 分支名称符合约定。
- Commit message 能说明变更类型和内容。
- PR 包含修改目的、范围、预览链接和检查清单。
- Review 负责人明确。
- 合并前已确认 Vercel Preview。