jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-30 03:01:36 -05:00
Code Issues Projects Releases Wiki Activity

Update about-task-lists.md

Browse Source
This commit is contained in:
Christian Adamini
2021-12-17 23:27:46 +01:00
committed by GitHub
parent db0f087ed7
commit 723a1539a3
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
content/issues/tracking-your-work-with-issues/about-task-lists.md
View File

@@ -1,6 +1,6 @@
---
title: About task lists
intro: '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.'
intro: '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.'
redirect_from:
- /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/about-task-lists
- /articles/about-task-lists
@@ -26,7 +26,7 @@ topics:
## 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.
A task list is a set of tasks that each render on a separate line with a clickable checkbox. 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 {% data variables.product.product_name %}. {% ifversion fpt or ghec %}If you reference an issue, pull request, or discussion in a task list, the reference will unfurl to show the title and state.{% endif %}
@@ -40,7 +40,7 @@ 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 {% data variables.product.product_name %}, 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 {% octicon "issue-opened" aria-label="The issue opened icon" %} 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](/github/getting-started-with-github/using-github/keyboard-shortcuts#issues-and-pull-requests)."
- If a task requires further tracking or discussion, convert the task to an issue by hovering over the task and clicking {% octicon "issue-opened" aria-label="The issue opened icon" %} 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](/github/getting-started-with-github/using-github/keyboard-shortcuts#issues-and-pull-requests)."
- Any issues referenced in the task list will specify that they are tracked in the referencing issue.
![Rendered task list](/assets/images/help/writing/task-list-rendered.png)
@@ -51,9 +51,11 @@ If you add a task list to the body of an issue, the list has added functionality
{% data reusables.repositories.task-list-markdown %}
You cannot create task list items issues from closed issues or issues with linked pull requests.
## Reordering tasks
You can reorder the items in a task list by clicking to the left of a task's checkbox, dragging the task to a new location, and dropping the task. You can reorder tasks across different lists in the same comment, but you can not reorder tasks across different comments.
Reorder the items in a task list by clicking to the left of a task's checkbox, dragging the task to a new location, and dropping the task. You can reorder tasks across different lists in the same comment, but you can not reorder tasks across different comments.
{% ifversion fpt %} ![Reordered task list](/assets/images/help/writing/task-list-reordered.gif)
{% else %} ![Reordered task list](/assets/images/enterprise/writing/task-lists-reorder.gif) {% endif %}
@@ -71,4 +73,4 @@ Any issues that are referenced in a task list specify that they are tracked by t
## Further reading
* "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax)"{% ifversion fpt or ghes > 3.3 or ghae-issue-5036 %}
* "[Tracking {% data variables.product.prodname_code_scanning %} alerts in issues using task lists](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists)"{% endif %}
* "[Tracking {% data variables.product.prodname_code_scanning %} alerts in issues using task lists](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists)"{% endif %}