Quick Start¶
This page walks through the minimum steps to get a checklist appearing on your first issue.
1. Create a template¶
In the repo where you'll open issues (or in your org's .github repo), create a file at:
Paste this minimal template:
## Pre-triage
- [ ] Steps to reproduce confirmed
- [ ] Affected version(s) noted
## Review
- [ ] [Security implications checked](https://wiki.example.com/security-review)
- [ ] Linked to a milestone
Tip
The [Link text](url) syntax adds a small doc link icon next to the item. The link is informational — clicking it opens the doc in a new tab.
2. Open an issue¶
Open a new issue in the repo. Set the Issue type to Bug (GitHub's native issue type field — not a label).
Within a few seconds, the app posts a bot comment with the rendered checklist.
3. Update checklist items¶
Click the Open checklist link in the bot comment. GitHub OAuth verifies you're a repo collaborator, then shows the full checklist editor.
Mark items as:
- Done — work is complete
- N/A — not applicable to this issue
- Need Exception — requires approval from a second party (see Exceptions)
4. Embed the status badge¶
Copy the badge URL from the bot comment and paste it into any Markdown:
The badge updates live as checklist state changes.
Next: read about the full template format and exception approval flow.