Skip to content

Commit 3173bff

Browse files
committed
Tweak the bug report template
- Ask for a description in the first textarea. - Remove warning block about resolver report. - Mark "How to Reproduce" as a required validation. - Add `render: sh-session` to the output handling. - Simplify CoC agreement checkbox.
1 parent 3edbd7c commit 3173bff

File tree

1 file changed

+52
-71
lines changed

1 file changed

+52
-71
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 52 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,62 @@
1-
---
21
name: Bug report
32
about: Something is not working correctly.
43
title: ""
54
labels: "S: needs triage, type: bug"
6-
issue_body: true # default: true, adds a classic WSYWIG textarea, if on
7-
body:
8-
- type: markdown
9-
attributes:
10-
value: |
11-
12-
If you're reporting an issue for `--use-feature=2020-resolver`,
13-
use the "Dependency resolver failures / errors" template instead.
14-
- type: markdown
15-
attributes:
16-
value: "**Environment**"
17-
- type: input
18-
attributes:
19-
label: pip version
20-
validations:
21-
required: true
22-
- type: input
23-
attributes:
24-
label: Python version
25-
validations:
26-
required: true
27-
- type: input
28-
attributes:
29-
label: OS
30-
validations:
31-
required: true
32-
- type: textarea
33-
attributes:
34-
label: Additional information
35-
description: >-
36-
Feel free to add more information about your environment here.
37-
38-
- type: textarea
39-
attributes:
40-
label: Description
41-
description: >-
42-
A clear and concise description of what the bug is.
435

44-
- type: textarea
45-
attributes:
46-
label: Expected behavior
47-
description: >-
48-
A clear and concise description of what you expected to happen.
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Description
10+
description: >-
11+
A clear and concise description of what the bug is.
12+
validations:
13+
required: true
4914

50-
- type: textarea
51-
attributes:
52-
label: How to Reproduce
53-
description: >-
54-
Describe the steps to reproduce this bug.
55-
value: |
56-
1. Get package from '...'
57-
2. Then run '...'
58-
3. An error occurs.
15+
- type: textarea
16+
attributes:
17+
label: Expected behavior
18+
description: >-
19+
A clear and concise description of what you expected to happen.
5920
60-
- type: textarea
61-
attributes:
62-
label: Output
63-
description: >-
64-
Paste the output of the steps above, including the commands
65-
themselves and pip's output/traceback etc.
66-
value: |
67-
```console
21+
- type: input
22+
attributes:
23+
label: pip version
24+
validations:
25+
required: true
26+
- type: input
27+
attributes:
28+
label: Python version
29+
validations:
30+
required: true
31+
- type: input
32+
attributes:
33+
label: OS
34+
validations:
35+
required: true
6836

69-
```
37+
- type: textarea
38+
attributes:
39+
label: How to Reproduce
40+
description: Please provide steps to reproduce this bug.
41+
value: |
42+
1. Get package from '...'
43+
2. Then run '...'
44+
3. An error occurs.
45+
validations:
46+
required: true
7047

71-
- type: checkboxes
72-
attributes:
73-
label: Code of Conduct
74-
description: |
75-
Read the [PSF Code of Conduct][CoC] first.
48+
- type: textarea
49+
attributes:
50+
label: Output
51+
description: >-
52+
Provide the output of the steps above, including the commands
53+
themselves and pip's output/traceback etc.
54+
render: sh-session
7655

77-
[CoC]: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md
78-
options:
79-
- label: I agree to follow the PSF Code of Conduct
80-
required: true
81-
...
56+
- type: checkboxes
57+
attributes:
58+
label: Code of Conduct
59+
options:
60+
- label: >-
61+
I agree to follow the [PSF Code of Conduct](https://www.python.org/psf/conduct/).
62+
required: true

0 commit comments

Comments
 (0)