简介
本指南演示如何使用 GitHub Issues 来计划和跟踪一项工作。在本指南中,您将创建一个新议题并将其拆分为子议题。您还将学习如何添加标签、议题类型、里程碑、指派人以及项目,以传达议题的元数据。
先决条件
要创建议题,您需要一个仓库。您可以使用已有的、拥有写入权限的仓库,或创建一个新仓库。该仓库必须启用议题功能。有关创建仓库的更多信息,请参阅创建新仓库。有关在仓库中启用议题(如果已禁用)的更多信息,请参阅禁用议题。
打开空白议题
首先,创建一个议题。创建议题的方式有多种,您可以选择最适合工作流的方式。本示例将使用 GitHub UI。有关其他创建议题方式的更多信息,请参阅创建议题。
-
在 GitHub 上,导航至仓库的主页面。
-
在仓库名称下,点击 议题。

-
点击 New issue。
-
在本示例中,我们将从空白议题开始。您的仓库可能使用议题模板和议题表单来引导贡献者提供特定信息。如果您的仓库使用议题模板,请点击Open a blank issue。
填写信息
为议题提供一个描述性的标题。标题应一目了然地说明议题的内容。
添加一段说明,阐述议题的目的,并包括可能帮助解决议题的细节。例如,如果这是一个 bug 报告,请描述复现步骤、预期结果以及实际结果。
您可以使用 Markdown 添加格式、链接、表情符号等。有关详细信息,请参阅在 GitHub 上书写。

添加任务清单
您也可以使用纯文本跟踪没有对应议题的任务,并在以后将其转换为议题。有关详细信息,请参阅关于任务清单。

指派议题
为传达责任,您可以将议题指派给组织内的成员。请参阅将议题和 pull request 指派给其他 GitHub 用户。

添加标签
添加标签以对议题进行分类。例如,您可以使用 question 标签和 good first issue 标签,表示该议题是一个问题且适合首次贡献者处理。用户可以通过标签过滤议题,以查找拥有特定标签的所有议题。
您可以使用默认标签,或创建新标签。有关详细信息,请参阅管理标签。

添加议题类型
您可以添加议题类型,以在组织范围内对工作进行分类。请参阅在组织中管理议题类型。

将议题添加到项目
您可以将议题添加到已有项目中,并为项目填充元数据。有关项目的更多信息,请参阅关于项目。

添加里程碑
您可以添加里程碑,将议题纳入基于日期的目标进行跟踪。里程碑会在目标日期临近时显示议题的进展情况。请参阅关于里程碑。

提交议题
点击Submit new issue即可创建议题。创建后您仍可编辑上述任意字段。议题拥有唯一的 URL,您可以将其分享给团队成员,或在其他议题或 pull request 中引用。
添加子议题
您可以为议题添加子议题,以快速将较大的工作拆分为更小的议题。子议题通过在议题之间建立关系,为 GitHub 的层级结构提供支持。通过拆分任务,您可以创建多层级的子议题,精确呈现项目所需的细节层次。请参阅添加子议题和浏览子议题。

添加议题依赖关系
您可以使用议题依赖关系来定义阻塞关系。依赖关系帮助您识别被其他工作阻塞或阻塞其他工作的议题。请参阅创建议题依赖关系。
沟通
议题创建后,可通过添加评论继续交流。您可以 @ 提及协作者或团队,以引起他们对评论的注意。若要在同一仓库中关联相关议题,只需键入 # 并输入议题标题的一部分,然后点击需要链接的议题。更多信息请参阅在 GitHub 上书写。

后续步骤
议题可用于多种场景,例如:
- 跟踪想法
- 收集反馈
- 规划任务
- 报告 bug
若要将议题拆分为更易管理的任务,您可以添加多层级的子议题。请参阅添加子议题。
以下资源可帮助您进一步使用 GitHub Issues:
- 想了解更多关于议题的信息,请参阅关于议题。
- 想了解 GitHub 规划与跟踪工具的核心要点,请参阅为您的团队或项目规划与跟踪工作。
- 想了解项目如何帮助您进行规划与跟踪,请参阅了解项目。
- 想了解如何使用议题模板和议题表单来引导贡献者提供特定信息,请参阅使用模板鼓励提交有价值的议题和 pull request。