About tasklists

You can use tasklists to break the work for an issue or pull request into smaller tasks, then track the full set of work to completion.

Кто может использовать эту функцию?

Markdown можно использовать в веб-интерфейсе GitHub .

В этой статье

About tasklists

Внимание

Tasklists are retired. You can read more about this on the GitHub Blog.

You can use sub-issues as the replacement for tasklist blocks. Sub-issues provide a dedicated section within each issue, making it easier to track related work without relying on Markdown. For more information about sub-issues, see Добавление вложенных проблем.

A tasklist is a set of tasks that each render on a separate line with a clickable checkbox. You can select or deselect the checkboxes to mark the tasks as complete or incomplete.

You can use Markdown to create a tasklist in any comment on GitHub. If you reference an issue, pull request, or discussion in a tasklist, the reference will unfurl to show the title and state.

About issue tasklists

If you add a tasklist to the body of an issue, the list has added functionality.

  • To help you track your team's work on an issue, the progress of an issue's tasklist appears in various places on GitHub, such as a repository's list of issues.
  • If a task references another issue and someone closes that issue, the task's checkbox will automatically be marked as complete.
  • If a task requires further tracking or discussion, you can convert the task to an issue by hovering over the task and clicking in the upper-right corner of the task. To add more details before creating the issue, you can use keyboard shortcuts to open the new issue form. For more information, see сочетания клавиш;.
  • Any issues referenced in the tasklist will specify that they are tracked in the referencing issue.

Screenshot of an issue showing a tasklist under the header "Features." Three list items link to other issues.

Creating tasklists

Чтобы создать список задач, добавьте к элементам списка префикс — дефис, пробел, а затем [ ]. Чтобы пометить задачу как завершенную, используйте [x].

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

Снимок экрана: отрисованная версия markdown. Ссылки на проблемы отображаются в виде заголовков проблем.

Примечание.

You cannot create tasklist items within closed issues or issues with linked pull requests.

Reordering tasks

You can reorder the items in a tasklist. First, click or hover to the left of a task's checkbox until a grid of six dots appears. Then, drag and drop the grid to move the task to a new location.

You can reorder tasks across different lists in the same comment, but you cannot reorder tasks across different comments.

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

Converting tasks into issues

You can also convert tasks into issues. First, hover over one of the items in your tasklist and then click .

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

Any issues that are referenced in a tasklist specify that they are tracked by the issue that contains the tasklist. To navigate to the tracking issue from the tracked issue, click on the tracking issue number in the Tracked by section next to the issue status.

Screenshot of issue 3 showing the issue status of "Open" and the text "Tracked by issue #2", which is outlined in orange.