Note: Tasklists are in private beta and subject to change. We have currently paused onboarding to the beta.
You can use the Add tasklist button to quickly add a tasklist to your issue. The Add tasklist button is available when you view or edit an issue.
Navigate to the issue you want to contain your new tasklist. You can also create a new issue.
At the bottom of the issue description, click Add tasklist.
You can then add issues, pull requests, and draft tasks to your new tasklist. For more information, see "Managing tasks in a tasklist."
You can create tasklists using Markdown in the issue description (the opening comment of an issue). You can include links to issues and pull requests or create draft issues.
You can add a tasklist by copying the Markdown below into your issue description:
```[tasklist] ### My tasks - [ ] https://github.com/octo-org/octo-repo/issues/45 - [ ] Draft task ```
You can also use the Add tasklist button while editing your issue to insert the Markdown for a tasklist:
Once you have started editing your tasklist Markdown, you can add new tasks by preceding each new task with
- [ ] and then adding either:
- A draft task. Draft tasks are text that can later be converted into issues.
- The full link to an issue or pull request. For example,
https://github.com/octo-org/octo-repo/issues/45. If an issue or pull request is in the same repository as your tasklist, you can use the #ISSUE-NUMBER shorthand syntax. For example,
If you add a draft task, it must meet these requirements:
- Draft tasks can be formatted using Markdown.
- Draft tasks must not exceed 512 characters in length.
Your tasklist will be rendered by GitHub when you preview your changes and when you save the issue. You can then make changes and add issues and draft tasks using the GitHub UI. If you edit the issue description, you will be able to modify the Markdown directly or copy the Markdown to duplicate the tasklist in other issues.
When you create a new tasklist, the default title is "Tasks." You can modify the title by clicking Rename in the tasklist's context menu or by editing the issue's markdown.
In the top-right of the issue body, select and click Edit.
In the fenced code block that starts with ````[tasklist]
, add a header with your new title, such as### My new title`.
Click Update comment.
When you copy your tasklist using the "Copy Markdown" option, GitHub copies Markdown to your clipboard and includes the issue title so you can paste the tasklist outside of GitHub without losing context. See below for an example of a copied Markdown tasklist:
- [x] [Design new landing page]( ) - [ ] [Translate content into supported languages]( )
In the top-right of your tasklist, click .
In the menu, click Copy markdown.