简介
本指南说明如何使用 GitHub Issues 来规划和跟踪一项工作。 在本指南中,你将创建一个新议题。 你还将了解如何添加标签、里程碑、被分派人和项目,以传达有关议题的元数据。
先决条件
要创建议题,您需要一个仓库。 您可以使用您有写入权限的现有仓库,或者创建一个新的仓库。 存储库必须启用议题。 有关创建存储库的详细信息,请参阅“创建新仓库”。 有关启用存储库中已禁用的问题的详细信息,请参阅“禁用议题”。
打开空白议题
首先,创建议题。 创建议题的方法有很多种:您可以为工作流程选择最方便的方法。 此示例将使用 GitHub UI。 有关创建问题的其他方法的详细信息,请参阅“创建议题”。
-
在 GitHub 上,导航到存储库的主页面。
-
在存储库名称下,单击 “问题”。
-
单击“新建问题”。
-
在此示例中,我们将从空白议题开始。 存储库可能使用问题模板来鼓励参与者提供具体信息。 如果存储库使用问题模板,请单击“打开空白问题”。
填写信息
为议题提供一个描述性标题。 标题应一目了然地传达议题的内容。
添加解释问题目的之说明,包括任何可能有助于解决问题的详细信息。 例如,如果这是漏洞报告,请描述重现漏洞的步骤、预期结果和实际结果。
您可以使用 Markdown 添加格式、链接、表情等内容。 有关详细信息,请参阅“在 GitHub 上写入”。
添加议题依赖项
可以使用议题依赖项来定义议题之间的阻止关系。 通过议题依赖项,可以识别被其他工作阻止或阻止其他工作的议题。 请参阅“创建议题依赖项”。
沟通
创建议题后,通过向议题添加评论来继续对话。 可以 @mention 协作者或团队以提醒他们注意评论。 要链接同一存储库中的相关问题,可以键入 #
,后接问题标题的一部分,然后单击要链接的问题。 有关详细信息,请参阅“在 GitHub 上写入”。
后续步骤
您可以将议题用于广泛的用途。 例如:
- 跟踪想法
- 收集反馈
- 规划任务
- 报告 Bug
以下是一些帮助你对 GitHub Issues 执行后续步骤的有用资源:
- 若要了解有关问题的详细信息,请参阅“关于议题”。
- 若要了解使用 GitHub 的计划和跟踪工具的基本知识,请参阅“为您的团队或项目规划和跟踪工作”。
- 若要详细了解项目如何帮助你进行规划和跟踪,请参阅 了解 Projects。
- 若要详细了解如何使用问题模板来鼓励参与者提供特定信息,请参阅“使用模板鼓励有用的议题和拉取请求”。