简介
本指南说明如何使用 GitHub Issues 来规划和跟踪一项工作。 在本指南中,你将创建一个新议题并将其分解为子议题。 你还将了解如何添加标签、议题类型、里程碑、被分派人和项目,以传达有关议题的元数据。
先决条件
要创建议题,您需要一个仓库。 您可以使用您有写入权限的现有仓库,或者创建一个新的仓库。 存储库必须启用议题。 有关创建存储库的详细信息,请参阅“创建新仓库”。 有关启用存储库中已禁用的问题的详细信息,请参阅“禁用议题”。
打开空白议题
首先,创建议题。 创建议题的方法有很多种:您可以为工作流程选择最方便的方法。 此示例将使用 GitHub UI。 有关创建问题的其他方法的详细信息,请参阅“创建议题”。
-
在 GitHub 上,导航到存储库的主页面。
-
在仓库名称下,单击 “Issues”****。
-
单击“新建问题”。
-
在此示例中,我们将从空白议题开始。 存储库可能使用问题模板和问题表单来鼓励参与者提供具体信息。 如果存储库使用问题模板,请单击“打开空白问题”。
填写信息
为议题提供一个描述性标题。 标题应一目了然地传达议题的内容。
添加解释问题目的之说明,包括任何可能有助于解决问题的详细信息。 例如,如果这是漏洞报告,请描述重现漏洞的步骤、预期结果和实际结果。
您可以使用 Markdown 添加格式、链接、表情等内容。 有关详细信息,请参阅“在 GitHub 上写入”。
添加任务列表
还可以使用纯文本来跟踪没有相应议题的任务,并在以后将其转换为议题。 有关详细信息,请参阅“关于任务列表”。
分配议题
要传达责任,您可以将议题分配给您的组织成员。 请参阅“分配议题和拉取请求到其他 GitHub 用户”。
添加标签
添加标签对议题分类。 例如,可使用 question
标签和 good first issue
标签来指示某个议题是首次参与者可能发现的问题。 用户可以通过标签过滤议题,以查找所有具有特定标签的议题。
您可以使用默认标签,也可以创建新标签。 有关详细信息,请参阅“管理标签”。
添加议题类型
可以添加议题类型以对整个组织中的工作进行分类。 请参阅“管理组织中的问题类型”。
添加议题到项目
可将问题添加到现有项目,并为项目填充元数据。 有关项目的详细信息,请参阅 关于 Projects。
添加里程碑
您可以添加里程碑来跟踪议题,作为基于日期的目标的一部分。 随着目标日期的临近,里程碑将显示议题的进度。 请参阅“关于里程碑”。
提交议题
单击“提交新问题”以创建问题。 您可以在创建议题后编辑任何上述字段。 您的议题具有独特的 URL,可以与团队成员共享,或在其他议题或拉取请求中引用。
添加子问题
可以向议题添加子议题,以便快速将较大的工作分解为较小的议题。 子问题通过创建问题之间的关系,增加了对 GitHub 上的问题层次结构的支持。 可以创建多个层次结构级别,通过将任务精确地分解为你和你的团队所需的细节量来准确表示项目。 请参阅“添加子问题”和“浏览子问题”。
添加议题依赖项
可以使用议题依赖项来定义议题之间的阻止关系。 通过议题依赖项,可以识别被其他工作阻止或阻止其他工作的议题。 请参阅“创建议题依赖项”。
沟通
创建议题后,通过向议题添加评论来继续对话。 可以 @mention 协作者或团队以提醒他们注意评论。 要链接同一存储库中的相关问题,可以键入 #
,后接问题标题的一部分,然后单击要链接的问题。 有关详细信息,请参阅“在 GitHub 上写入”。
后续步骤
您可以将议题用于广泛的用途。 例如:
- 跟踪想法
- 收集反馈
- 规划任务
- 报告 Bug
若要将问题分解为更易于管理的任务,可以添加多个级别的子问题。 请参阅“添加子问题”。
以下是一些帮助你对 GitHub Issues 执行后续步骤的有用资源:
- 若要了解有关问题的详细信息,请参阅“关于议题”。
- 若要了解使用 GitHub 的计划和跟踪工具的基本知识,请参阅“为您的团队或项目规划和跟踪工作”。
- 若要详细了解项目如何帮助你进行规划和跟踪,请参阅 了解 Projects。
- 若要详细了解如何使用问题模板和问题表单来鼓励参与者提供特定信息,请参阅“使用模板鼓励有用的议题和拉取请求”。