Skip to content

Commit 6155350

Browse files
authored
Replace issue template system with structured one (#102)
1 parent 975e06d commit 6155350

File tree

7 files changed

+86
-49
lines changed

7 files changed

+86
-49
lines changed

.github/ISSUE_TEMPLATE/---bug-report.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/---feature-request.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/---support-question.md

Lines changed: 0 additions & 10 deletions
This file was deleted.
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: 🐛 Bug Report
2+
description: Report errors and problems
3+
labels: [ bug ]
4+
body:
5+
- type: input
6+
id: php-versions
7+
attributes:
8+
label: PHP version(s) affected
9+
placeholder: x.y.z
10+
validations:
11+
required: true
12+
- type: input
13+
id: batch-versions
14+
attributes:
15+
label: Package(s) and version(s) affected
16+
placeholder: yokai/package x.y.z
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: description
21+
attributes:
22+
label: Description
23+
description: A clear and concise description of the problem
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: how-to-reproduce
28+
attributes:
29+
label: How to reproduce
30+
description: |
31+
⚠️ This is the most important part of the report ⚠️
32+
Without a way to easily reproduce your issue, there is little chance we will be able to help you and work on a fix.
33+
Please, take the time to show us some code and/or config that is needed for others to reproduce the problem easily.
34+
Most of the time, creating a "bug reproducer" is the best way to help.
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: possible-solution
39+
attributes:
40+
label: Possible Solution
41+
description: |
42+
Optional: only if you have suggestions on a fix/reason for the bug
43+
Don't hesitate to create a pull request with your solution, it helps get faster feedback.
44+
- type: textarea
45+
id: additional-context
46+
attributes:
47+
label: Additional Context
48+
description: |
49+
Optional: any other context about the problem: log messages, screenshots, etc.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: 🚀 Feature Request
2+
description: RFC and ideas for new features and improvements
3+
labels: [ enhancement ]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: A clear and concise description of the new feature
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: example
14+
attributes:
15+
label: Example
16+
description: |
17+
A simple example of the new feature in action (include PHP code, YAML config, etc.)
18+
If the new feature changes an existing feature, include a simple before/after comparison.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: 🤨 Support Question
2+
description: Ask for help if you are stuck with something
3+
labels: [ question ]
4+
body:
5+
- type: textarea
6+
id: description
7+
attributes:
8+
label: Description
9+
description: A clear and concise description of problem you are facing
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: code
14+
attributes:
15+
label: Code
16+
description: |
17+
If your problem is related to some code, please provide it.
18+
Include the Job code, config, some external resources if possible, and the JobExecution if you have it.

.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

0 commit comments

Comments
 (0)