第 3 课 Issue:一件事开一张单
这一课学完: 每件要做的事都先变成一个 Issue。从 Issue 开分支、开 PR,PR 合并时 Issue 自动关掉,事情做没做完一眼就能看到。

Issue 是什么
Issue 是仓库里的一张任务单:要修的问题、要加的功能、要回答的疑问,都可以开一个。它有编号(#12)、有讨论区,能和 PR 互相关联。
只记在脑子里或聊天记录里的事,过两天就找不到了。开成 Issue,谁提的、为什么做、做到哪了,都留在仓库里。
一张好 Issue 写什么
- 标题: 写结果,不写过程。「订单金额为零时不能提交」比「看一下订单的问题」好。
- 现象: 现在是什么样,怎么复现,最好附截图或报错原文。
- 期望: 改完应该是什么样。
- 验收: 怎样算做完,例如「金额为零时按钮置灰,并提示原因」。
bash
gh issue create --title "订单金额为零时不能提交" --body "现象:……
期望:……
验收:……"从 Issue 到合并:一件事一条线
text
Issue #12 → 分支 fix/issue-12-zero-total → PR(说明里写 Closes #12) → 合并 → #12 自动关闭关键是 PR 说明里的这一行:
text
Closes #12PR 合进默认分支(通常是 main)时,GitHub 会自动关掉 #12。写 Fixes #12、Resolves #12 也一样。
规矩只有一条:一个 Issue,一条分支,一个 PR。 一个 PR 里混着三件事,审的人看不清,出了问题也没法只退回其中一件。
给别人的项目提 Issue
在开源项目里,先搜一下有没有人提过同样的问题,再开新的。写清楚版本、系统、复现步骤。想自己修,先在 Issue 里说一声,等维护者同意再动手,免得白做。
这一步谁来做
| 交给 AI 的 | 你要判断和验收的 |
|---|---|
| 把你口述的问题整理成 Issue,写现象、期望、验收 | 这件事值不值得做、现在做不做;验收标准是不是你要的;合并后 Issue 确实关了 |
练习
给自己的项目开两个 Issue。挑一个,按「Issue → 分支 → PR → Closes」走一遍,合并后确认它自动关闭了。
上一课:第 2 课 分支和 PR · 下一课:第 4 课 Actions