跳至主要内容

任务列表快速入门

遵循本指南了解如何在 UI 和 Markdown 中创建和修改任务列表。

注意: 任务列表处于私人测试阶段,可能会发生变化。我们目前已暂停加入测试版。

简介

本指南演示了如何使用任务列表将较大的工作分解成多个任务列表和多个子任务。您将学习如何使用 UI 创建任务列表,如何使用 Markdown 创建任务列表,如何更改任务列表以及如何将新任务列表与项目集成。

为了帮助演示如何使用任务列表将工作分解成更小的子任务,本指南将遵循一个场景,我们需要为新功能创建一个登录页面。您可以随意遵循本指南,但可以加入您自己的场景。

先决条件

在您遵循本指南的过程中,您将在存储库中创建多个问题。您需要一个可以创建问题的存储库。

创建问题以跟踪添加新登录页面的工作

在此步骤中,我们将创建父问题以跟踪发布新登录页面所需的子任务。

  1. 导航到您要跟踪工作的存储库。
  2. 创建一个标题为“跟踪登录页面问题”的新空白问题。有关更多信息,请参阅“创建问题”。

创建第一个任务列表

任务列表添加到问题的开头评论(问题描述)中。问题可以包含多个标题不同的任务列表。这是对子任务进行分类的好方法。

  1. 转到您刚刚创建的问题。如果您还没有这样做,请按提交新问题
  2. 在问题描述的底部,单击 添加任务列表.

Screenshot an issue. The "Add tasklist" button is highlighted with an orange outline.

这将在您的问题中插入一个空任务列表。

添加草稿任务

草稿任务是添加到您的任务列表中的文本项目。草稿任务在您的任务列表中显示一个复选框。您可以使用草稿任务快速勾勒出项目的必要条件和子任务,并可以选择将其转换为问题。

  1. 如果文本字段尚未获得焦点,请单击添加项目到任务

    Screenshot of a tasklist. The "Add item to Tasks" field is highlighted with an orange rectangle.

  2. 添加一些草稿任务来概述这项工作。输入您的草稿任务,然后在每个任务后按 Enter 键。

    以我们的示例登录页面场景为例,您可以添加

    • "设计新的登录页面"
    • "创建登录页面内容"
    • "将内容翻译成支持的语言"

将草稿任务转换为问题

您可以将草稿任务转换为问题。当您准备好开始处理特定任务时,可以转换草稿任务。问题将在您用于跟踪问题的同一存储库中创建。

  1. 在“设计新的登录页面”草稿任务旁边,单击 .

    Screenshot of a tasklist. To the right of a draft task, the tracking block item menu is outlined in orange.

  2. 在菜单中,单击 **转换为问题**。

将自己分配到新问题

您现在可以将自己分配到新问题,而无需离开您的任务列表。

  1. 在任务列表中的“设计新的登录页面”问题旁边,单击 .

    Screenshot of a tasklist. To the right of a task, the tracking block item menu, which is labeled with a horizontal kebab icon, is outlined in dark orange.

  2. 在上下文菜单中,单击 **设置分配者**。

  3. 在人员列表中,选择自己。

您也可以使用此上下文菜单来设置标签并将问题添加到项目中。

重命名任务列表

您可以更改任务列表的标题,以更好地表示它正在跟踪的任务。当您在同一个问题中有多个任务列表并希望对任务进行细分时,这尤其有用。

  1. 在任务列表的右上角,单击 .

    Screenshot of a tasklist. The tracking block item menu, which is labeled with a horizontal kebab icon, is outlined in dark orange.

  2. 在菜单中,单击 **重命名**。

  3. 为您的任务列表输入一个新标题,然后按 Enter 键。

    以我们的示例登录页面场景为例,您可以将此任务列表重命名为“登录页面内容”。

使用 Markdown 创建第二个任务列表

您可以在单个问题中创建多个任务列表。每个任务列表都有自己的任务和标题。您可以使用 **添加任务列表** 按钮或在编辑问题时输入 Markdown 来添加任务列表。

  1. 在问题描述(开头评论)的顶部,单击 .

    Screenshot of an issue containing a tasklist. The "Show options" button is highlighted with an orange rectangle.

  2. 在菜单中,单击 **编辑**。

  3. 在问题描述中,在第一个任务列表下方,添加以下 Markdown

    Markdown
    ```[tasklist]
    ### Tasks
    - [ ] Draft task
    ```
    
  4. 要更改此任务列表的标题,请在 ### 后输入一个新标题。例如,将 ### 任务 更改为 ### 后端更改

在接下来的两个部分中,我们将对 Markdown 进行进一步更改,然后再保存评论。

使用 Markdown 添加草稿任务

您可以通过直接在任务列表中使用 Markdown 输入来快速添加新的草稿任务。

  1. 在最后一个任务之后创建一个新行,输入- [ ] 和您的新任务,即可添加新的草稿任务。例如,- [ ] 注册表格
  2. 通过修改- [ ] 后的文本,编辑现有的草稿任务。例如,将- [ ] 草稿任务更改为- [ ] 数据库模式

使用 Markdown 添加现有问题

您还可以通过将现有问题添加到任务列表中来跟踪它们。您可以使用 Markdown 或通过粘贴问题 URL 在 UI 中添加现有问题。您可以添加您有权访问的任何存储库中的问题和拉取请求。

  1. 在新行中开始输入- [ ] ,然后粘贴问题的完整 URL。例如,- [ ] https://github.com/octo-org/octo-repo/issues/45
  2. 点击更新评论

Screenshot of an issue being edited. There are two tasklists present and the "Update comment" button is highlighted with an orange rectangle.

您将看到新的第二个任务列表显示在第一个任务列表下方。

跟踪进度

任务列表可以帮助您快速查看已选择跟踪的任务的状态和进度。

  1. 在草稿任务的左侧,选择复选框以将该任务标记为已完成。
  2. 点击您之前从草稿转换的 issue。
  3. 在转换后的 issue 中,页面底部,点击关闭 issue

当您返回任务列表并刷新页面时,您可以看到您刚刚关闭的 issue 现在有一个图标表示它已关闭。在 issue 标题下方,进度显示为“6 个任务中的 2 个”。

Screenshot of an issue containing two tasklists. One issue is closed and one draft task is marked as completed. The progress information is highlighted with an orange rectangle.

与项目集成

您在任务列表中建立的关系在您的项目中可用。您可以快速查看每个 issue 的进度,浏览子任务,并设置使用您的任务列表的视图。

  1. 导航到与您用于任务列表和 issue 的用户或组织帐户相同的用户或组织帐户拥有的项目。如果您没有可用的项目,您可以创建一个。有关更多信息,请参阅“创建项目”。

  2. 在您的项目中使用表格布局创建一个新视图。有关视图的更多信息,请参阅“管理您的视图”。

  3. 将任务列表中的一个问题添加到您的项目中。有关将项目添加到项目的更多信息,请参阅“将项目添加到您的项目”。

  4. 点击 当前打开的视图名称旁边的。

    Screenshot showing the tabs at the top of a project. The view menu icon is highlighted with an orange outline.

  5. 在菜单中,点击**按分组**,然后选择**跟踪方式**。这将创建一个视图,其中您的问题按跟踪它们的项目进行分组。

将问题和拉取请求添加到任务列表时,不会自动将其添加到项目中。当您按“跟踪方式”字段对视图进行分组时,GitHub 会提示您添加与任务列表关联的其他问题。

  1. 如果您的任务列表中存在不在项目中的问题,您可以点击组下方的**1 个项目不在此项目中**。

Screenshot of a project in the table layout. At the bottom of a group, "1 item not in this project" is highlighted with an orange rectangle.

  1. 在问题列表中,点击您要添加的问题。如果您有多个问题,您可以选择添加所有问题。

结论

按照本指南操作后,您已创建了一个包含两个任务列表的跟踪问题,在 UI 和 Markdown 中直接对这些任务列表进行了更改,将草稿任务转换为问题,并将您的任务列表数据与项目集成。

要了解有关管理任务列表中项目的更多信息,请参阅“管理任务列表中的任务”。有关将任务列表与项目集成的更多信息,请参阅“使用项目和任务列表”。