About task lists

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

Who can use this feature?

Markdown can be used in the GitHub web interface.

In this article

About task lists

A task list 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 task list in any comment on GitHub. If you reference an issue, pull request, or discussion in a task list, the reference will unfurl to show the title and state.

About issue task lists

If you add a task list 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 task list 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 "Keyboard shortcuts."
  • Any issues referenced in the task list will specify that they are tracked in the referencing 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.

Creating task lists

To create a task list, preface list items with a hyphen and space followed by [ ]. To mark a task as complete, use [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.

Tip

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

Reordering tasks

You can reorder the items in a task list. 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 task list. 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 task list and then click .

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

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

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.

Further reading