Skip to content

Commit 0d363dc

Browse files
authored
Merge pull request #548 from bburt-rh/add-issue-templates
Adding new templates for submitting issues. We want issues to have a severity level. Then, we can have a Service Level Agreement (SLA) for SL1 and SL2 bugs, in particular.
2 parents 389baca + 4cb3e73 commit 0d363dc

File tree

3 files changed

+122
-0
lines changed

3 files changed

+122
-0
lines changed
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: "🐞 Bug report"
2+
description: Report a problem or bug you found in the supplementary style guide.
3+
labels: [bug]
4+
body:
5+
- type: dropdown
6+
id: severity
7+
attributes:
8+
label: Severity
9+
description: What is the impact of this bug?
10+
options:
11+
- Critical (blocks usage or causes data loss)
12+
- Major (significant impact, but workaround exists)
13+
- Minor (cosmetic or small impact)
14+
- Trivial (no real impact)
15+
validations:
16+
required: true
17+
- type: dropdown
18+
id: priority
19+
attributes:
20+
label: Priority
21+
description: How urgently should this be fixed?
22+
options:
23+
- P1 (highest)
24+
- P2
25+
- P3 (lowest)
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: affected-pages
30+
attributes:
31+
label: Affected page(s)
32+
description: Please provide a link (or links) to the page(s) where you found the bug.
33+
placeholder: "https://github.com/redhat-documentation/supplementary-style-guide/path/to/page"
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: describe-bug
38+
attributes:
39+
label: Describe the bug, along with repro steps
40+
description: What went wrong? Be as specific as possible.
41+
placeholder: "A clear and concise description of the bug."
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: proposed-fix
46+
attributes:
47+
label: Describe the proposed fix
48+
description: What fix do you recommend to resolve or improve this issue?
49+
placeholder: "Describe your proposed fix here."
50+
validations:
51+
required: true
52+
- type: markdown
53+
attributes:
54+
value: |
55+
---
56+
**Optional next step:**
57+
After submitting this issue, you can help resolve it by [opening a pull request](https://github.com/redhat-documentation/supplementary-style-guide/compare) that references this issue.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: "✨ Enhancement request"
2+
description: Suggest an improvement or new feature for the supplementary style guide.
3+
labels: [enhancement]
4+
body:
5+
- type: dropdown
6+
id: severity
7+
attributes:
8+
label: Severity
9+
description: How important is this enhancement?
10+
options:
11+
- Critical (blocks usage or causes major problems)
12+
- Major (highly desirable)
13+
- Minor (nice to have)
14+
- Trivial (minor improvement)
15+
validations:
16+
required: true
17+
- type: dropdown
18+
id: priority
19+
attributes:
20+
label: Priority
21+
description: How urgently should this be addressed?
22+
options:
23+
- P1 (highest)
24+
- P2
25+
- P3 (lowest)
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: relevant-pages
30+
attributes:
31+
label: Relevant page(s)
32+
description: Link(s) to pages related to this enhancement.
33+
placeholder: "https://github.com/redhat-documentation/supplementary-style-guide/path/to/page"
34+
validations:
35+
required: false
36+
- type: textarea
37+
id: proposed-change
38+
attributes:
39+
label: Describe the proposed change
40+
description: What change or enhancement would you like to see?
41+
placeholder: "Describe your proposed change here."
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: change-justification
46+
attributes:
47+
label: Why is this change needed?
48+
description: Why do you think this change is important? What problem does it solve or what improvement does it provide?
49+
placeholder: "Explain the need for this enhancement."
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: additional-context
54+
attributes:
55+
label: Additional context
56+
description: Add any other context or screenshots about the enhancement here.
57+
validations:
58+
required: false
59+
- type: markdown
60+
attributes:
61+
value: |
62+
---
63+
**Optional next step:**
64+
After submitting this issue, you can help resolve it by [opening a pull request](https://github.com/redhat-documentation/supplementary-style-guide/compare) that references this issue.

0 commit comments

Comments
 (0)