Skip to content

Commit bcc4d93

Browse files
mpokeMSalopek
andauthored
add isssue forms (#3057)
Co-authored-by: MSalopek <[email protected]>
1 parent 6c6a514 commit bcc4d93

8 files changed

+141
-145
lines changed
+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: 🐛 Bug report
2+
description: Create a report to help us squash bugs!
3+
title: "[Bug]: "
4+
labels: ["type: bug", "status: waiting-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
Before smashing the submit button please review the template.
11+
12+
- type: checkboxes
13+
attributes:
14+
label: Is there an existing issue for this?
15+
description: Please search existing issues to avoid creating duplicates.
16+
options:
17+
- label: I have searched the existing issues
18+
required: true
19+
20+
- type: markdown
21+
attributes:
22+
value: |
23+
IMPORTANT: Prior to opening a bug report, check if it affects one of the core modules
24+
and if its eligible for a bug bounty on `SECURITY.md`. Bugs that are not submitted
25+
through the appropriate channels won't receive any bounty.
26+
- type: textarea
27+
id: what-happened
28+
attributes:
29+
label: What happened?
30+
description: Also tell us, what did you expect to happen?
31+
placeholder: Tell us what you see!
32+
value: "A bug happened!"
33+
validations:
34+
required: true
35+
- type: input
36+
attributes:
37+
label: Gaia Version
38+
description: If applicable, specify the version you're using
39+
placeholder: v15.0.0, v15.1.0, main, etc.
40+
validations:
41+
required: true
42+
- type: textarea
43+
id: reproduce
44+
attributes:
45+
label: How to reproduce?
46+
description: If applicable could you describe how we could reproduce the bug
47+
placeholder: Tell us how to reproduce the bug!
48+
validations:
49+
required: false
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: Feature Request
2+
description: Create a proposal to request a feature
3+
title: "[Feature]: "
4+
labels: ["type: feature-request", "status: waiting-triage", "admin: epic"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
✰ Thanks for opening an issue! ✰
10+
11+
- type: textarea
12+
id: summary
13+
attributes:
14+
label: Summary
15+
description: |
16+
What are the user needs?
17+
How could this solution fix the user facing problem?
18+
placeholder: Short, concise description of the proposed feature/changes to the repository
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: problem
24+
attributes:
25+
label: Problem Definition
26+
description: |
27+
If applicable please answer the below questions
28+
Why do we need this feature?
29+
What problems may be addressed by introducing this feature?
30+
What benefits does Gaia stand to gain by including this feature?
31+
Are there any disadvantages of including this feature?
32+
placeholder: Description of the issue being faced
33+
validations:
34+
required: false
35+
36+
- type: textarea
37+
id: proposal
38+
attributes:
39+
label: Proposed Feature
40+
description: |
41+
Description of the proposed features or changes to an existing feature to meet your needs
42+
placeholder: Description of the proposed feature(s)
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: work
48+
attributes:
49+
label: Work Breakdown
50+
description: |
51+
Break the work into many tasks that will later be turned into issues that can be assigned to developers to work on.
52+
placeholder: Description of the steps needed to deliver this feature
53+
value: |
54+
```[tasklist]
55+
#### Must have
56+
- [ ] discuss proposal (if proposal rejected, close EPIC)
57+
- [ ] create ADR (if ADR rejected, close EPIC)
58+
- [ ] add sub-tasks needed to implement the proposed feature
59+
```
60+
61+
```[tasklist]
62+
#### Nice to have
63+
- [ ] add sub-tasks that are nice to have for the proposed feature
64+
```
65+
validations:
66+
required: true
+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Documentation Request
2+
description: Create an issue for missing or incorrect documentation
3+
title: "[Docs]: "
4+
labels: ["type: docs-req", "status: waiting-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
✰ Thanks for opening an issue! ✰
10+
Tell us what you would like to see get added to the documentation or if there is an error in the documentation?
11+
12+
- type: textarea
13+
id: what-happened
14+
attributes:
15+
label: Summary
16+
placeholder: Description of what you would like to see
17+
validations:
18+
required: true

.github/ISSUE_TEMPLATE/epic-template.md .github/ISSUE_TEMPLATE/04-epic-template.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
2-
name: EPIC Template
3-
about: Basic template for EPICs (used by the team)
4-
labels: "admin: epic", "status: waiting-triage"
2+
name: Epic Template
3+
about: Basic template for epics (used by the team)
4+
title: "[Epic]: "
5+
labels: ['admin: epic', 'status: waiting-triage']
56
---
67

78
## Problem
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: Issue Template
33
about: Basic template for issues (used by the team)
4-
labels: "status: waiting-triage"
4+
labels: 'status: waiting-triage'
55
---
66

77
<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
@@ -10,15 +10,15 @@ v Before smashing the submit button please review the template.
1010
v Please also ensure that this is not a duplicate issue :)
1111
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -->
1212

13-
# Problem
13+
## Problem
1414

1515
<!-- Please write a concise 1-3 line problem. -->
1616

17-
# Closing criteria
17+
## Closing criteria
1818

1919
<!-- Please write a satisfiable criteria for closing this issue. -->
2020

2121

22-
# Problem details
22+
## Problem details
2323

2424
<!-- Please describe the problem in all detail. -->

.github/ISSUE_TEMPLATE/bug-report.md

-34
This file was deleted.

.github/ISSUE_TEMPLATE/feature-request.md

-50
This file was deleted.

.github/ISSUE_TEMPLATE/tech-debt.md

-54
This file was deleted.

0 commit comments

Comments
 (0)