Skip to content

Commit 0176500

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 0176500

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

β€Ž.github/ISSUE_TEMPLATE/bug-report.ymlβ€Ž

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,7 @@ body:
1212
1313
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.
1414
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-
###
15+
This project is covered with unit- and integration tests and successfully used in many projects. If an error related to this library occurs in your project, please create a pull request with a failing test to prove the error falls in scope of the library.
2016
- type: textarea
2117
attributes:
2218
label: Describe the bug
@@ -29,7 +25,11 @@ body:
2925
description: |
3026
You can generate a list with `composer show`.
3127
This can help with finding outdated dependencies or known conflicts.
32-
render: json
28+
Please make sure to wrap the output in code fences for better readability πŸ™πŸ».
29+
value: |
30+
```
31+
# Paste output here
32+
```
3333
validations:
3434
required: true
3535
- type: textarea
@@ -38,7 +38,11 @@ body:
3838
description: |
3939
You can generate a list with `composer show --platform`.
4040
This can help with finding missing, outdated or conflicting PHP versions and extensions.
41-
render: shell
41+
Please make sure to wrap the output in code fences for better readability πŸ™πŸ».
42+
value: |
43+
```
44+
# Paste output here
45+
```
4246
validations:
4347
required: true
4448
- type: textarea
@@ -49,6 +53,7 @@ body:
4953
Please use code blocks for better readability.
5054
Please note that bugs without minimal reproductions can be closed as non-actionable.
5155
If single, self-contained code snippets are not sufficient, please provide the link to a git Repository visualising the issue.
56+
Please make sure to wrap code in code fences for better readability πŸ™πŸ».
5257
5358
value: |
5459
```shell
@@ -67,11 +72,12 @@ body:
6772
attributes:
6873
label: Error message/Stack trace
6974
description: |
70-
If a stack trace is available, please include it in full, or type `-`
71-
render: shell
72-
validations:
73-
required: true
74-
75+
If a stack trace is available, please include it in full.
76+
Please make sure to wrap the output in code fences for better readability πŸ™πŸ».
77+
value: |
78+
```
79+
# Paste output here
80+
```
7581
- type: textarea
7682
attributes:
7783
label: Additional information

0 commit comments

Comments
Β (0)