跳到主要内容

关于任务列表

您可以使用任务列表将 Issue 或 Pull Request 的工作分解成更小的任务,然后跟踪整个工作直至完成。

关于任务列表

任务列表是一组任务,每个任务都在单独一行上显示,并带有一个可点击的复选框。您可以选择或取消选择复选框以将任务标记为已完成或未完成。

您可以在 GitHub 的任何评论中使用 Markdown 创建任务列表。如果您在任务列表中引用 Issue、Pull Request 或讨论,则该引用将展开以显示标题和状态。

关于 Issue 任务列表

如果您在 Issue 的正文中添加任务列表,则该列表将具有附加功能。

  • 为了帮助你追踪团队在某个 issue 上的工作进度,issue 任务列表的进度会显示在 GitHub 的多个位置,例如仓库的 issue 列表。
  • 如果某个任务引用了另一个 issue,并且有人关闭了该 issue,则任务的复选框将自动标记为已完成。
  • 如果某个任务需要进一步跟踪或讨论,你可以将任务转换为 issue。方法是将鼠标悬停在任务上,然后点击任务右上角的按钮。要在创建 issue 之前添加更多详细信息,可以使用键盘快捷键打开新的 issue 表单。更多信息,请参见“键盘快捷键”。
  • 任务列表中引用的任何 issue 都将指定它们是在引用 issue 中进行跟踪的。

Screenshot of a GitHub issue showing a task list under the header "Features." Some items are checked as done, others unchecked as undone. Three list items link to other GitHub Issues.

创建任务列表

要创建任务列表,请在列表项前加上连字符和空格,然后加上[ ]。要将任务标记为已完成,请使用[x]

- [x] #739
- [ ] https://github.com/octo-org/octo-repo/issues/740
- [ ] Add delight to the experience when all tasks are complete :tada:

Screenshot showing the rendered version of the markdown. The references to issues are rendered as issue titles.

提示

你无法在已关闭的 issue 或与 pull request 关联的 issue 中创建任务列表项。

重新排序任务

你可以重新排序任务列表中的项目。首先,点击或将鼠标悬停在任务复选框左侧,直到出现六个点的网格。然后,拖动并放下网格以将任务移动到新位置。

你可以在同一评论中不同列表之间重新排序任务,但不能在不同评论之间重新排序任务。

Screenshot of a GitHub issue showing two tasks in a task list. A grid of six dots to the left of the second task is outlined in dark orange.

将任务转换为 issue

你也可以将任务转换为 issue。首先,将鼠标悬停在任务列表中的某个项目上,然后点击.

Screenshot of a GitHub issue showing two tasks. The"Convert to issue" icon is highlighted with an orange outline.

任务列表中引用的任何 issue 都将指定它们是由包含该任务列表的 issue 跟踪的。要从被跟踪的 issue 导航到跟踪 issue,请点击 issue 状态旁边的“**Tracked in**”部分中的跟踪 issue 编号。

Screenshot of a GitHub issue named "Create relationships between issues" and numbered issue 3. A button below the issue title reading "Tracked by issue #2" is outlined in dark orange.

进一步阅读