diff --git a/assets/images/help/writing/task-list-rendered-simple.png b/assets/images/help/writing/task-list-rendered-simple.png new file mode 100644 index 0000000000..0effa46bfe Binary files /dev/null and b/assets/images/help/writing/task-list-rendered-simple.png differ diff --git a/assets/images/help/writing/task-list-rendered.png b/assets/images/help/writing/task-list-rendered.png index 691beda218..155e78b042 100644 Binary files a/assets/images/help/writing/task-list-rendered.png and b/assets/images/help/writing/task-list-rendered.png differ diff --git a/assets/images/help/writing/task-list-reordered.gif b/assets/images/help/writing/task-list-reordered.gif index b2a702eec5..896b561c32 100644 Binary files a/assets/images/help/writing/task-list-reordered.gif and b/assets/images/help/writing/task-list-reordered.gif differ diff --git a/content/github/getting-started-with-github/using-github/keyboard-shortcuts.md b/content/github/getting-started-with-github/using-github/keyboard-shortcuts.md index 6276d15838..464426ca30 100644 --- a/content/github/getting-started-with-github/using-github/keyboard-shortcuts.md +++ b/content/github/getting-started-with-github/using-github/keyboard-shortcuts.md @@ -104,7 +104,10 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr |m | Set a milestone. For more information, see "[Associating milestones with issues and pull requests](/articles/associating-milestones-with-issues-and-pull-requests/)." |l | Apply a label. For more information, see "[Applying labels to issues and pull requests](/articles/applying-labels-to-issues-and-pull-requests/)." |a | Set an assignee. For more information, see "[Assigning issues and pull requests to other {% data variables.product.company_short %} users](/articles/assigning-issues-and-pull-requests-to-other-github-users/)." -|cmd + shift + p or control + shift + p | Toggles between the **Write** and **Preview** tabs +|cmd + shift + p or control + shift + p | Toggles between the **Write** and **Preview** tabs{% if currentVersion == "free-pro-team@latest" %} +|alt and click | When creating an issue from a task list, open the new issue form in the current tab by holding alt and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)." +|shift and click | When creating an issue from a task list, open the new issue form in a new tab by holding shift and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)." +|command or control + shift and click | When creating an issue from a task list, open the new issue form in the new window by holding command or control + shift and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)."{% endif %} ## Changes in pull requests diff --git a/content/github/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls.md b/content/github/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls.md index ca44647bff..387c2d27c0 100644 --- a/content/github/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls.md +++ b/content/github/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls.md @@ -37,6 +37,10 @@ Within conversations on {% data variables.product.product_name %}, references to | `Username/Repository#` and issue or pull request number | jlord/sheetsee.js#26 | [jlord/sheetsee.js#26](https://github.com/jlord/sheetsee.js/issues/26) | `Organization_name/Repository#` and issue or pull request number | github/linguist#4039 | [github/linguist#4039](https://github.com/github/linguist/pull/4039) +{% if currentVersion == "free-pro-team@latest" %} +If you reference an issue, pull request, or discussion in a list, the reference will unfurl to show the title and state instead. For more information about task lists, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)." +{% endif %} + ## Commit SHAs References to a commit's SHA hash are automatically converted into shortened links to the commit on {% data variables.product.product_name %}. diff --git a/content/issues/tracking-your-work-with-issues/creating-issues/about-issues.md b/content/issues/tracking-your-work-with-issues/creating-issues/about-issues.md index 8a1795c608..0cae9c8291 100644 --- a/content/issues/tracking-your-work-with-issues/creating-issues/about-issues.md +++ b/content/issues/tracking-your-work-with-issues/creating-issues/about-issues.md @@ -15,7 +15,7 @@ topics: --- ## About issues -You can collect user feedback, report software bugs, and organize tasks you'd like to accomplish with issues in a repository. Issues can act as more than just a place to report software bugs. +You can collect user feedback, report software bugs, and organize tasks you'd like to accomplish with issues in a repository. Issues can act as more than just a place to report software bugs. Within an issue, you can use task lists to break work into smaller tasks and track the full set of work to completion. For more information, see "[About task lists](/issues/tracking-your-work-with-issues/creating-issues/about-task-lists)." {% if currentVersion == "free-pro-team@latest" %} Other conversations are more suitable for discussions. {% data reusables.discussions.you-can-use-discussions %} diff --git a/content/issues/tracking-your-work-with-issues/creating-issues/about-task-lists.md b/content/issues/tracking-your-work-with-issues/creating-issues/about-task-lists.md index da3ba7499c..24d11c60a7 100644 --- a/content/issues/tracking-your-work-with-issues/creating-issues/about-task-lists.md +++ b/content/issues/tracking-your-work-with-issues/creating-issues/about-task-lists.md @@ -1,6 +1,6 @@ --- title: About task lists -intro: You can use task lists to create a list of items with checkboxes within pull request and issue comments or Markdown files in your repository. +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. redirect_from: - /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/about-task-lists - /articles/about-task-lists @@ -11,14 +11,38 @@ versions: github-ae: '*' topics: - Pull requests + - Issues --- -Task lists render with clickable checkboxes in comments. You can select or unselect the checkboxes to mark them as complete or incomplete. -Task lists render as read-only checkboxes in Markdown files. People with write permissions in the repository can edit the file to select or unselect the checkboxes. +{% if currentVersion == "free-pro-team@latest" %} +{% note %} +**Note:** Improved task lists are currently in beta and subject to change. + +{% endnote %} +{% endif %} + +### 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 {% data variables.product.product_name %}. {% if currentVersion == "free-pro-team@latest" %}If you reference an issue, pull request, or disussion in a task list, the reference will unfurl to show the title and state.{% endif %} + +{% if currentVersion != "free-pro-team@latest" %} You can view task list summary information in issue and pull request lists, when the task list is in the initial comment. +{% else %} -![Task list summary](/assets/images/help/issues/task-list-summary.png) +### 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 {% 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 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)." + +![Rendered task list](/assets/images/help/writing/task-list-rendered.png) + +{% endif %} ## Creating task lists @@ -26,7 +50,7 @@ You can view task list summary information in issue and pull request lists, when ## Reordering tasks -You can reorder task lists within a single comment by clicking to the left of a task's checkbox, dragging it to a new location, and dropping it. If you have multiple lists within a comment, you can reorder tasks across the single comment. You can't add or reorder tasks across different comments. +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. ![Reordered task list](/assets/images/help/writing/task-list-reordered.gif) diff --git a/data/reusables/repositories/task-list-markdown.md b/data/reusables/repositories/task-list-markdown.md index 60a3de4d67..b93c9f7e52 100644 --- a/data/reusables/repositories/task-list-markdown.md +++ b/data/reusables/repositories/task-list-markdown.md @@ -1,9 +1,9 @@ To create a task list, preface list items with a regular space character followed by `[ ]`. To mark a task as complete, use `[x]`. ``` -- [x] Finish my changes -- [ ] Push my commits to GitHub -- [ ] Open a pull request +- [x] #739 +- [ ] https://github.com/octo-org/octo-repo/issues/740 +- [ ] Add delight to the experience when all tasks are complete :tada: ``` -![Rendered task list](/assets/images/help/writing/task-list-rendered.png) +![Rendered task list](/assets/images/help/writing/task-list-rendered-simple.png)