[] Open item
[open] Another open item
[in progress] Item with status 'in progress' which is still unchecked
[done] Completed/checked item with status 'done'
[skipped] Completed/checked item with status 'skipped'
Optional Items
A question mark ? is used to markitems as optional
[] Unchecked checklist item with description
>> Description text can be long and multiline.
>> It can contain links, mentions, dates, and other formatting elements.
[x] Checked item without description
Headers / Separators
You can use Headers to organize long checklists. Headers are proceeded by three dashes ---
--- Acceptance Criteria Header
- checklist item 1
- checklist item 2 with **bold** text
- checklist item 3 with link to an issue IC-245
Headers must include text. Three dashes that are not followed by text will not be saved/rendered on the checklist UI.
Additional Elements
Dates
Dates can be included in multiple formats.
Type // (double slash) to open a calendar picker.
[] Due on 2022-05-18
[] Due on 2022/05/18
[] Due on 18-05-2022
[] Due on 18/05/2022
Emojis
Type a colon : to open the emoji menu
* [open] Smile 😀
Issue Keys
To reference another issue, type the issue key
* [open] See the comment on CSP-61
URLs
URLs can be added in and will be rendered as clickable links
To bold text, add two asterisks, or two underscore characters before and after the word or phrase
This is **bold text**
This is __bold text__
Italics
To italicize text, add one asterisk or underscore character before and after a word or phrase
This is in *italics*
This is in _italics_
Strikethrough
To strikethrough text, add two tilde characters before and after a word or phrase
This text is ~~wrong~~
Inline Code
To style text as inline code, add back-tick characters before and after a word or phrase
This will be shown as `inline code`
Links
Add aURL directly into the text, or enclose the link text in brackets and follow it immediately with the URL in parentheses
Contact us at https://www.herocoders.com/contact
[Contact us](https://www.herocoders.com/contact)
Emails
Add the email address directly into text, or enclose the link text in brackets follow it immediately with a mailto data (you can specify email subject too)
Contact us at support@herocoders.com.
[Contact us](mailto:support@herocoders.com?subject=Issue Checklist questions&body=Email body text)
Escaping Markdown Characters
To display Markdown formatting characters, use the backslash \ character like demonstrated below
Formatting is not applied due to backslash \ usage
The backslash \ is not displayed when it is used to escape Markdown
Double backslashes are used to display a single backslash inside a Markdown formatted phrase
The backslash behaves like a normal character when used outside Markdown formatted phrase
Issue Checklist uses square brackets to represent the state of an item in the text format. Therefore, when you include square brackets at the beginning of a checklist item they are removed. To show brackets in your checklist item, use the \ character prior to the opening bracket.