用途:面向 GitHub 仓库的收尾工作流,在一个 GitHub Issue(目标)的代码实现完成后,依次完成提交代码、推送分支、创建 PR、合入 PR、关闭 Issue,并在 Issue 上留下实现总结评论。
前置条件:当前 git 仓库已有针对该 Issue 的代码变更;已知 Issue 编号(如 #42);gh CLI 已登录,可用 gh auth status 验证。
主要步骤:1) 用 git status、git diff --stat HEAD 检查状态,git add 仅暂存本 Issue 相关文件,git commit 时在 message 中写入 #issue-number 关联 Issue。2) 若在 main/master 先 git checkout -b 建分支,再 git push -u origin 分支,分支名建议 feat/issue-42-short-desc 或 fix/issue-42-short-desc。3) 用 gh pr create 创建 PR,body 中写 Closes #N 或 Fixes #N,title 不超过 70 字符。4) 用 gh pr checks 确认检查通过后 gh pr merge,可加 --squash、--rebase、--merge 之一及 --delete-branch。5) 在 Issue 上添加实现总结评论,结构参考 note-it 的 Design Decisions、Deviations、Tradeoffs、Open Questions 四类,无内容写 None,另含核心变更与实现亮点,并附 PR 编号与 commit hash。6) 若 PR 未自动关闭 Issue,则 gh issue close {issue-number} --reason completed。
使用方式:按上述顺序执行给出的 gh 与 git 命令;正文中正文分步含 bash 命令示例,保持原样执行即可。
适用场景:单人或多人的 GitHub 仓库开发,Issue 驱动、需要 PR 评审后合入并回溯设计决策的流程。
限制:仅适用于 GitHub 且已安装并登录 gh CLI;需要仓库有相应权限(分支保护可能阻止合并);自动关闭依赖 PR body 中写 Closes/Fixes;若存在 merge conflict 需 rebase 后 force push。具体错误处理与更多细节见原文步骤。