跳至主要内容

GitHub 问题快速入门

按照本简短互动指南了解 GitHub Issues。

简介

本指南演示如何使用 GitHub Issues 来规划和跟踪工作。在本指南中,您将创建一个新 issue 并添加一个任务列表来跟踪子任务。您还将学习如何添加标签、里程碑、指派人和项目,以传达有关 issue 的元数据。

先决条件

要创建 issue,您需要一个存储库。您可以使用具有写访问权限的现有存储库,也可以创建一个新存储库。必须启用存储库中的 issue。有关创建存储库的更多信息,请参阅“创建新存储库”。有关在存储库中禁用 issue(如果已禁用)的更多信息,请参阅“禁用 issue”。

打开空白 issue

首先,创建一个 issue。有多种方式可以创建 issue;您可以选择最适合您工作流的方法。此示例将使用 GitHub UI。有关创建 issue 的其他方法的更多信息,请参阅“创建 issue”。

  1. 在 GitHub.com 上,导航到存储库的主页。

  2. 在存储库名称下,单击 Issues.

    Screenshot of the main page of a repository. In the horizontal navigation bar, a tab, labeled "Issues," is outlined in dark orange.

  3. 单击新建 issue

  4. 在此示例中,我们将从空白 issue 开始。您的存储库可以使用 issue 模板和 issue 表单来鼓励贡献者提供特定信息。如果您的存储库使用 issue 模板,请单击打开空白 issue

填写信息

为您的 issue 起一个描述性标题。标题应一目了然地传达 issue 的内容。

添加一个描述来解释 issue 的目的,包括可能有助于解决 issue 的任何详细信息。例如,如果这是一个错误报告,请描述重现错误的步骤、预期结果和实际结果。

您可以使用标记添加格式、链接、表情等。有关详细信息,请参阅“在 GitHub 上编写”。

Screenshot of the new issue form, with a title and body filled in.

添加任务列表

将大型问题分解为较小的任务,或在单个较大的问题中跟踪多个相关问题可能会有所帮助。通过在列表项前加上 [ ] 为您的问题添加任务列表。通过问题编号或 URL 引用现有问题。您可以使用纯文本来跟踪没有对应问题的任务,并稍后将它们转换为问题。有关详细信息,请参阅“关于任务列表”。

Screenshot of the new issue form, with the title and body filled in. The body includes the Markdown for a task list.

添加标签

添加标签以对您的问题进行分类。例如,您可以使用 bug 标签和 good first issue 标签来表明问题是一个新手贡献者可以解决的 bug。用户可以按标签筛选问题,以查找具有特定标签的所有问题。

您可以使用默认标签,也可以创建新标签。有关详细信息,请参阅“管理标签”。

Screenshot of the new issue form. In the right sidebar, the "Labels" section is outlined in dark orange.

添加里程碑

您可以添加里程碑,以根据日期目标跟踪问题。随着目标日期临近,里程碑将显示问题的进度。有关详细信息,请参阅“关于里程碑”。

Screenshot of the new issue form. In the right sidebar, the "Milestone" section is outlined in dark orange.

分配问题

为了明确责任,您可以将问题分配给贵组织的成员。有关详细信息,请参阅“将问题和 Pull Request 分配给其他 GitHub 用户”。

Screenshot of the new issue form. In the right sidebar, the "Assignees" section is outlined in a dark orange.

将问题添加到项目

您可以将问题添加到现有项目,并为项目填充元数据。有关项目的详细信息,请参阅“关于项目”。

Screenshot of the new issue form. In the right sidebar, the "Projects" section is outlined in dark orange.

提交您的问题

单击“提交新问题”以创建您的问题。在创建问题后,您可以编辑上述任何字段。您的问题有一个唯一的 URL,您可以与团队成员共享,或在其他问题或 Pull Request 中引用。

交流

创建问题后,通过向问题中添加评论来继续对话。你可以 @ 提及合作者或团队,以引起他们对评论的注意。要链接同一存储库中的相关问题,你可以输入 #,后跟问题标题的一部分,然后单击你要链接的问题。有关详细信息,请参阅“在 GitHub 上撰写”。

Screenshot of an issue comment. The header says "octocat commented now" and the body says "@hubot Do we also need to update the rocket logic?"

后续步骤

你可以将问题用于广泛的目的。例如

  • 跟踪想法
  • 收集反馈
  • 规划任务
  • 报告错误

以下是一些有用的资源,可帮助你使用 GitHub 问题执行后续步骤