-
Notifications
You must be signed in to change notification settings - Fork 60.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
New tasklists also allow shorthand syntax #26521
New tasklists also allow shorthand syntax #26521
Conversation
Automatically generated comment ℹ️This comment is automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.
fpt: Free, Pro, Team |
👋 Hey @HonkingGoose - great to have another contribution from you 🎉 I'll get this triaged for review! ⚡ |
While you guys are triaging my change, also check if other parts of the document need to be changed as well. For example there's an example that only shows the full URL, and no shorthand-syntax:
I could add a line like this to the
Also I don't know if |
content/issues/tracking-your-work-with-issues/about-tasklists.md
Outdated
Show resolved
Hide resolved
Thank you for your contribution @HonkingGoose |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much for adding this, @HonkingGoose! I'll get this merged shortly and make sure we include this in future iterations of these docs.
@@ -45,7 +45,7 @@ You can create a tasklist using Markdown in the issue description (the opening c | |||
1. To begin your tasklist, type <code>```[tasklist]</code> (triple backticks and <code>tasklist</code> inside square brackets) on a new line in the issue description. | |||
1. Optionally, type `### TITLE` on the next line, replacing `TITLE` with a title for your tasklist. | |||
1. For each item you want to add to your tasklist, type `- [ ]` on a new line, followed by a space, and either a link to an issue, a link to a pull request, or some text to create a draft issue. | |||
- You must provide a full link to an issue or pull request. For example, `https://github.com/octo-org/octo-repo/issues/45`. | |||
- You may provide a full link to an issue or pull request or, if the issue or pull request is in the same repository as your tasklist, you can use the #ISSUE-NUMBER shorthand syntax. For example, `https://github.com/octo-org/octo-repo/issues/45` or `#45`. | |||
- Tasks can be formatted with Markdown. | |||
- Tasks must not exceed 256 characters in length. | |||
1. To finish your tasklist, type <code>```</code> on a new line after the last item. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@stevecat before you merge, did you check if you want to update the [tasklist]
example on line 55 through 61? Maybe that example should also show the shorthand-syntax?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@HonkingGoose Thanks for the reminder! ✨ I think we'll keep this as the optional step in the procedural for now. I think the example is super clear at the moment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's okay! Thanks for merging my contribution! 😄
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Why:
@omerbensaadon is a PM with GitHub, they said that the new tasklist feature also accepts
#45
shorthand-syntax. The current docs say you must use the full URL like this:https://github.com/octo-org/octo-repo/issues/45
Fixes a part of issue #24862. It should not close the issue as more work is needed after my PR gets merged. 😉
What's being changed (if available, include any code snippets, screenshots, or gifs):
Rewrite a list item to allow both full URL and shorthand syntax, with examples of both.
Check off the following:
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.
data
directory.For content changes, I have completed the self-review checklist.