Skip to content

Commit 2021c31

Browse files
author
Terraform
committed
chore: Update generic issue template
1 parent 7aa64ce commit 2021c31

1 file changed

Lines changed: 64 additions & 8 deletions

File tree

.github/ISSUE_TEMPLATE/1-generic-issue.md

Lines changed: 64 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,81 @@ assignees: ''
77

88
---
99

10+
<!--
11+
How to fill out this template:
12+
13+
1. Describe outcomes, not implementation. Explain WHAT should happen and WHY,
14+
not HOW to build it. Implementation details belong in a PR, not in an issue.
15+
2. Acceptance Criteria MUST use GitHub checkboxes (`- [ ] ...`), not plain
16+
bullets (`- ...`). Plain bullets are not parsed as tasks by GitHub or by
17+
automation/AI tools and will be missed during triage.
18+
3. Keep every section. If a section does not apply, write `N/A` as its body.
19+
Do not delete sections and do not leave placeholder text.
20+
4. Delete every HTML comment (including this one) as you fill in the sections.
21+
Comments are guidance for the writer and should not remain in the submitted
22+
issue.
23+
-->
24+
1025
## Description
1126

12-
Description of the problem, with any relevant context to better understand the issue.
27+
<!--
28+
What is the problem or request, and why does it matter? Include any context
29+
a reader needs to understand the issue without prior knowledge. Avoid jumping
30+
to a solution here — describe the problem first.
31+
32+
Delete this comment when you fill in the section.
33+
-->
1334

1435
## Expected Behavior or Outcome
1536

16-
- Key requirements and specifications.
37+
<!--
38+
The user-visible behavior or outcome once this is resolved. Phrase as
39+
observable results ("the command exits with code 0", "the page renders X"),
40+
not as code changes ("we add a foo() function").
41+
42+
Use either a bulleted list or a short narrative paragraph — whichever fits
43+
the issue best.
44+
45+
Delete this comment when you fill in the section.
46+
-->
47+
48+
- Listed item, or use the narrative style
1749

1850
## Acceptance Criteria
1951

20-
- Criteria for acceptance and success.
21-
- Optional section
52+
<!--
53+
Concrete, verifiable conditions that must be true to consider this issue done.
54+
55+
REQUIRED FORMAT: each criterion MUST be a GitHub checkbox so it is tracked as
56+
a task by GitHub, automations, and AI agents:
57+
58+
- [ ] The CLI exits with code 0 when the input file is valid.
59+
- [ ] An error message is shown when the file is missing.
60+
61+
Do NOT use plain bullets (`- ...`) — they will not be picked up as tasks.
62+
63+
Focus on outcomes ("the user sees X"), not on implementation ("we add a
64+
foo() function"). If criteria can't be defined yet, write `N/A`.
65+
66+
Delete this comment when you fill in the section.
67+
-->
68+
69+
- [ ]
2270

2371
## Resources/References
2472

25-
- Links to relevant documentation or tools.
26-
- Optional section
73+
<!--
74+
Links to relevant docs, tools, dashboards, related issues, or prior
75+
discussions. Write `N/A` if there are none.
76+
77+
Delete this comment when you fill in the section.
78+
-->
2779

2880
## Notes
2981

30-
- Any additional information or context.
31-
- Optional section
82+
<!--
83+
Any additional context that doesn't fit above. Write `N/A` if there is
84+
nothing to add.
85+
86+
Delete this comment when you fill in the section.
87+
-->

0 commit comments

Comments
 (0)