议题
议题为团队提供了一个共享的场所,用于跟踪缺陷、规划功能,以及记录任何需要关注的事项,并且直接关联到存储库中的代码。
- 打开存储库并选择 Issues 选项卡。
- 选择 New Issue。
- 输入简明的标题,描述问题或任务。
- 使用 Markdown 撰写说明,可根据需要加入复现步骤、验收标准、屏幕截图或代码块。
- 选择 Submit New Issue 以发布。
使用标签和里程碑进行组织
Section titled “使用标签和里程碑进行组织”标签用于对议题分类和设置优先级。查看议题时,可在右侧边栏中应用一个或多个标签,也可以使用标签筛选器直接在议题列表中应用。常见的做法是将类型标签(bug、enhancement)与优先级标签(high、low)搭配使用,但您也可以在 Issues → Labels 下创建任何适合工作流的标签。
里程碑将议题归集到共同的目标,例如发布日期、冲刺或功能目标。在 Issues → Milestones 下创建里程碑,然后从议题的侧边栏将议题分配到里程碑。里程碑视图会随着议题关闭而显示进度。
- Assignees:使用侧边栏中的 Assignees 字段指明负责人。任何有权访问该存储库的工作区成员都可以被指派。
- 注释:在议题说明下方的注释线程中添加背景信息、决策或状态更新。
- @提及:在注释或说明中的任意位置输入
@username,可直接通知对应的人。 - 回应:对注释使用表情符号回应,无需回复即可表示认可。
将议题链接到代码
Section titled “将议题链接到代码”在提交和拉取请求中引用议题,可使历史记录保持可追溯。
- 按编号引用:在提交消息、拉取请求说明或注释中输入
#12,即可创建指向同一存储库中议题 12 的可点击链接。 - 合并时自动关闭:在拉取请求说明中包含关闭关键字(例如
Closes #12、Fixes #34或Resolves #56)。当拉取请求合并到默认分支时,所引用的议题会自动关闭。 - 交叉引用其他议题:在任何议题注释中可随意使用
#number链接相关议题;每个被引用的议题都会显示反向链接,因此双方都能看到这种关联。
议题列表支持多个可组合使用的筛选器:
| 筛选器 | 作用 |
|---|---|
| 状态 | 显示未关闭或已关闭的议题 |
| 标签 | 缩小到一个或多个标签 |
| 里程碑 | 显示分配到某个里程碑的议题 |
| 负责人 | 显示指派给特定人员的议题 |
| 作者 | 显示由特定人员创建的议题 |
在议题列表上方的筛选栏中选择相应的列以应用各个筛选器。要使用关键字搜索议题标题和正文,请参阅搜索代码。