name: pr-workflow description: 提交、格式化、CI、依赖项、安全的一般指南
PR 工作流程指南
提交实践
- 原子提交。 小型、专注、单一目的
- 不要混合: 逻辑 + 格式化,逻辑 + 重构
- 良好消息 = 易于编写意图的简短描述
学习 git rebase -i 以获得清洁历史。
PR 指南
- 保持 PR 专注和小型
- 提交前运行相关测试
- 每个提交讲述故事的一部分
CI 环境笔记
如果作为 GitHub Action 运行:
- 在
.github/workflows/claude.yml中的最大轮次限制 - 可以提交 WIP 状态并推送
- 可以打开 WIP PR 并在另一个操作中继续
- 不要陷入兔子洞。保持专注于关键任务
安全
永远不要提交:
.env文件- 凭据
- 秘密
第三方依赖
当添加时:
- 在
licenses/下添加许可证文件 - 用依赖信息更新
NOTICE.md
外部 API/工具
- 永远不要猜测 API 参数或 CLI 参数
- 首先搜索官方文档
- 如果模糊,请求澄清