Skip to content

Commit 96dca33

Browse files
committed
Improve issue template
- Remove unnecessary markdown spacer - Remove inappropriate render directives - Add placeholders to help formatting output - Suggest backing up reports with failing tests
1 parent bdaaf54 commit 96dca33

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,12 @@ body:
1010
value: |
1111
### Important note
1212
13-
This issue form is for reporting bugs only. Please provide as much information as possible. If a problem cannot be reproduced or understood, your issue may be closed as non-actionable.
13+
This issue form is for reporting bugs only. Please provide as much information as possible. If a problem cannot
14+
be reproduced or understood, your issue may be closed as non-actionable.
1415
15-
This project is covered with unit- and integration tests and successfully used in many projects. If an error seemingly related to this library occurs in your project, it's most likely not because of this library.
16-
- type: markdown
17-
attributes:
18-
value: |
19-
###
16+
This project is covered with unit- and integration tests and successfully used in many projects. If an error
17+
related to this library occurs in your project, please create a pull request with a failing test to prove
18+
the error falls in scope of the library.
2019
- type: textarea
2120
attributes:
2221
label: Describe the bug
@@ -29,7 +28,11 @@ body:
2928
description: |
3029
You can generate a list with `composer show`.
3130
This can help with finding outdated dependencies or known conflicts.
32-
render: json
31+
Please make sure to wrap the output in code fences for better readability
32+
value: |
33+
```
34+
# Paste output here
35+
```
3336
validations:
3437
required: true
3538
- type: textarea
@@ -38,7 +41,10 @@ body:
3841
description: |
3942
You can generate a list with `composer show --platform`.
4043
This can help with finding missing, outdated or conflicting PHP versions and extensions.
41-
render: shell
44+
value: |
45+
```
46+
# Paste output here
47+
```
4248
validations:
4349
required: true
4450
- type: textarea
@@ -68,10 +74,12 @@ body:
6874
label: Error message/Stack trace
6975
description: |
7076
If a stack trace is available, please include it in full, or type `-`
71-
render: shell
77+
value: |
78+
```
79+
# Paste output here
80+
```
7281
validations:
7382
required: true
74-
7583
- type: textarea
7684
attributes:
7785
label: Additional information

0 commit comments

Comments
 (0)