Files
get-shit-done/.github/ISSUE_TEMPLATE/docs_issue.yml
Tom Boucher 1e46e820d6 chore: improve issue and PR templates with industry best practices (#1088)
Bug report template:
- Add OS, Node.js version, shell, and install method fields
- Add all 6 supported runtimes (+ Multiple option)
- Add frequency and severity/impact dropdowns
- Add config.json, STATE.md, and settings.json retrieval instructions
- Add PII warnings on every field that could leak sensitive data
- Recommend presidio-anonymizer and scrub for log anonymization
- Add diagnostic commands for debugging install issues
- Add mandatory PII review checklist checkbox

Feature request template:
- Add scope dropdown (core workflow, planning, context, runtime, etc.)
- Add runtime multi-select checkboxes

New templates:
- Documentation issue template (incorrect, missing, unclear, outdated)
- config.yml to disable blank issues and link Discord/Discussions

PR template:
- Add linked issue reference (Closes #)
- Add How section for approach description
- Add runtime testing checklist (all 5 runtimes + N/A)
- Add template/reference update check
- Add test pass check
- Add screenshots/recordings section
2026-03-16 08:54:52 -06:00

48 lines
1.1 KiB
YAML

---
name: Documentation Issue
description: Report incorrect, missing, or unclear documentation
labels: ["documentation"]
body:
- type: markdown
attributes:
value: |
Help us improve the docs. Point us to what's wrong or missing.
- type: dropdown
id: type
attributes:
label: Issue type
options:
- Incorrect information
- Missing documentation
- Unclear or confusing
- Outdated (no longer matches behavior)
- Typo or formatting
validations:
required: true
- type: input
id: location
attributes:
label: Where is the issue?
description: File path, URL, or section name
placeholder: "e.g., docs/USER-GUIDE.md, README.md#getting-started"
validations:
required: true
- type: textarea
id: description
attributes:
label: What's wrong?
description: Describe the documentation issue.
validations:
required: true
- type: textarea
id: suggestion
attributes:
label: Suggested fix
description: If you know what the correct information should be, include it here.
validations:
required: false