GitHub Checklist App¶
Structured, trackable checklists for your GitHub issues — with approval gates, org-wide templates, and dynamic SVG badges.
GitHub issues are free-form by nature. GitHub Checklist App adds structured, tri-state checklists to any issue the moment it's opened — no manual copy-paste, no external database, no separate tool.
How it works¶
When an issue is opened, the app:
- Detects the issue's type (using GitHub's native issue type field)
- Loads the matching checklist template from your repo or org
- Posts a managed bot comment with the rendered checklist and hidden state
- Provides a UI where collaborators can mark items as Done, N/A, or Need Exception
- Serves a live SVG badge reflecting the current checklist status
State lives entirely inside a hidden HTML comment in the bot's comment — no external database required.
Key features¶
| Feature | Description |
|---|---|
| Tri-state items | Each item is Done, N/A, or Need Exception — never just a checkbox |
| Approval workflow | Exceptions must be approved by a second party or an exception-approvers team member |
| Org-wide templates | Templates cascade from repo → private org → public org |
| Type-aware merging | When the issue type changes, existing progress is preserved for matching items |
| Transfer-aware | Works correctly when issues are transferred between repos |
| Dynamic SVG badge | Embed a live status badge anywhere — PR descriptions, wikis, dashboards |
| Zero external DB | All state lives in GitHub itself |