SuperAPI AI 工具集

pr-workflow

编程与开发

查看项目

更新于 10-16 07:21

技能介绍

PR Workflow Guide 是 Turso 仓库提供的 Pull Request 工作流通用指南,用于规范贡献者在提交代码、发起 PR、处理 CI、引入依赖和使用外部接口时的做法。

用途:帮助贡献者保持提交和 PR 聚焦、小而清晰,降低评审和合并难度,同时避免常见错误(如混入格式化改动、提交密钥、猜测 API 参数)。

主要能力(以指南形式给出):

  • 提交实践:原子提交,每个提交小而聚焦、单一目的;不要把逻辑改动与格式化或重构混在一起;好的提交信息应能用一句简短描述说明意图;建议学习 git rebase -i 保持整洁历史。
  • PR 指南:保持 PR 聚焦且小;提交前运行相关测试;每个提交讲述故事的一部分。
  • CI 环境注意事项:若作为 GitHub Action 运行,注意 .github/workflows/claude.yml 中的最大轮次限制;允许提交 WIP 状态并推送;允许开 WIP PR 并在另一个 action 中继续;不要陷入兔子洞,保持聚焦关键任务。
  • 安全:绝不提交 .env 文件、凭据或密钥。
  • 第三方依赖:添加依赖时,在 licenses/ 下添加许可证文件,并在 NOTICE.md 中更新依赖信息。
  • 外部 API/工具:绝不猜测 API 参数或 CLI 参数;先查官方文档;有歧义时请求澄清。

使用方式:作为仓库贡献时的参考规范,在提交、开 PR、配置 CI、引入依赖和调用外部接口时对照执行。

限制:资料未提供具体命令示例、工具版本、适用语言或强制校验机制;部分条款为建议性表述,未说明违规后果。