Skip to content

Commit 677b309

Browse files
authored
Merge pull request #6 from NF-Software-Inc/5-add-issue-templates
Add templates
2 parents 43fdfaa + bd145ba commit 677b309

4 files changed

Lines changed: 163 additions & 0 deletions

File tree

.github/ISSUE_TEMPLATE/1-bug.yml

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: "🐛 Bug"
2+
description: "Something is Broken / Incorrect"
3+
title: "[Bug]: "
4+
labels: ["bug", "help wanted"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please provide enough detail to reproduce quickly.
10+
11+
- type: dropdown
12+
id: severity
13+
attributes:
14+
label: Severity
15+
options:
16+
- "S1 - Work stopped / production impact"
17+
- "S2 - Major functionality broken"
18+
- "S3 - Minor issue / workaround exists"
19+
- "S4 - Cosmetic / nice-to-have"
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: what_happened
25+
attributes:
26+
label: What Happened?
27+
description: "What did you observe? Include exact error messages."
28+
placeholder: "Describe what you saw."
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: What Should Have Happened? (optional)
36+
validations:
37+
required: false
38+
39+
- type: textarea
40+
id: steps
41+
attributes:
42+
label: Steps To Reproduce (optional)
43+
placeholder: |
44+
1.
45+
2.
46+
3.
47+
validations:
48+
required: false
49+
50+
- type: textarea
51+
id: environment
52+
attributes:
53+
label: Environment (optional)
54+
placeholder: |
55+
App / Module:
56+
URL (if applicable):
57+
Browser:
58+
OS / Device:
59+
Location (if relevant):
60+
validations:
61+
required: false
62+
63+
- type: textarea
64+
id: evidence
65+
attributes:
66+
label: Logs / Screenshots / Video (optional)
67+
description: "Paste logs or describe attachments. (You can upload files after creating the issue, too.)"
68+
render: shell
69+
validations:
70+
required: false
71+
72+
- type: checkboxes
73+
id: checks
74+
attributes:
75+
label: Checks
76+
options:
77+
- label: "I searched existing issues and this is not a duplicate."
78+
required: true
79+
- label: "This is reproducible."
80+
required: false
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: "✨ Feature"
2+
description: "New Feature / Change Request"
3+
title: "[Feature]: "
4+
labels: ["enhancement", "help wanted"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Provide the problem + acceptance criteria so we can estimate and implement with minimal back-and-forth.
10+
11+
- type: dropdown
12+
id: priority
13+
attributes:
14+
label: Priority
15+
options:
16+
- "P1 - Critical / Contractual"
17+
- "P2 - High"
18+
- "P3 - Normal"
19+
- "P4 - Low"
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: problem
25+
attributes:
26+
label: Problem Statement
27+
description: "What problem are you trying to solve?"
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: proposal
33+
attributes:
34+
label: Proposed Solution (optional)
35+
description: "What do you want to happen?"
36+
validations:
37+
required: false
38+
39+
- type: textarea
40+
id: acceptance
41+
attributes:
42+
label: Acceptance Criteria
43+
placeholder: |
44+
- [ ] ...
45+
- [ ] ...
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: notes
51+
attributes:
52+
label: Notes / References (optional)
53+
description: "Screenshots, sample data, links, etc."
54+
validations:
55+
required: false
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: "🧾 General"
2+
description: "General Request, Question, Cleanup, Admin, Misc"
3+
title: "[General]: "
4+
labels: ["help wanted"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Use this when it's not clearly a bug or a feature request.
10+
11+
- type: textarea
12+
id: request
13+
attributes:
14+
label: Request / Question
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: context
20+
attributes:
21+
label: Context / Background (optional)
22+
validations:
23+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: "🔐 Security issue"
4+
url: "mailto:security@nathanaelfrey.com"
5+
about: "Report vulnerabilities privately."

0 commit comments

Comments
 (0)