Skip to content

Commit 0fd4539

Browse files
committed
Simplify bug report template
1 parent b58eb61 commit 0fd4539

File tree

1 file changed

+34
-46
lines changed

1 file changed

+34
-46
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

+34-46
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,34 @@ body:
77
attributes:
88
label: Describe the bug
99
description: >-
10-
A clear and concise description of what the bug is.
10+
A clear and concise description of what the bug is, including the
11+
expected behaviour and what has gone wrong.
12+
13+
Please include screenshots, if applicable.
1114
validations:
1215
required: true
1316

1417
- type: textarea
1518
attributes:
1619
label: How to Reproduce
17-
description: Please provide steps to reproduce this bug.
20+
description: >-
21+
Please provide steps to reproduce this bug, with the smallest possible
22+
set of source files. For normal bugs this should ideally be one
23+
``index.rst`` file, and for ``sphinx.ext.autodoc`` bugs, this should
24+
ideally be a single ``index.rst`` file, and a single example Python
25+
module.
1826
value: |
27+
Minimal method (you can also paste the contents of ``index.rst`` and
28+
``conf.py`` into this report):
29+
```bash
30+
$ echo "Content demonstrating the bug..." > index.rst
31+
$ echo "" > conf.py
32+
$ sphinx-build -M html . _build
33+
$ # open _build/html/index and see bla bla
1934
```
35+
36+
``git clone`` method (this is advised against, to help the Sphinx team):
37+
```bash
2038
$ git clone https://github.com/.../some_project
2139
$ cd some_project
2240
$ pip install -r requirements.txt
@@ -27,67 +45,37 @@ body:
2745
validations:
2846
required: true
2947

30-
- type: textarea
31-
attributes:
32-
label: Expected behavior
33-
description: >-
34-
A clear and concise description of what you expected to happen.
35-
36-
- type: input
37-
attributes:
38-
label: Your project
39-
description: >-
40-
Link to your sphinx project, or attach zipped small project sample.
41-
validations:
42-
required: true
43-
44-
- type: textarea
45-
attributes:
46-
label: Screenshots
47-
description: >-
48-
If applicable, add screenshots to help explain your problem.
49-
validations:
50-
required: false
51-
5248
- type: markdown
5349
attributes:
5450
value: |
5551
## Environment info
5652
5753
- type: input
5854
attributes:
59-
label: OS
55+
label: Environment Information
6056
description: >-
61-
[e.g. Unix/Linux/Mac/Win/other with version]
62-
validations:
63-
required: true
64-
- type: input
65-
attributes:
66-
label: Python version
67-
validations:
68-
required: true
69-
- type: input
70-
attributes:
71-
label: Sphinx version
57+
Install development Sphinx
58+
``pip install https://github.com/AA-Turner/sphinx/archive/refs/heads/5.x.zip``
59+
then run ``sphinx-build --bug-report`` or ``python -m sphinx --bug-report``.
60+
and paste the output here.
7261
validations:
7362
required: true
7463
- type: input
7564
attributes:
7665
label: Sphinx extensions
7766
description: >-
78-
[e.g. sphinx.ext.autodoc, recommonmark]
79-
validations:
80-
required: false
81-
- type: input
82-
attributes:
83-
label: Extra tools
84-
description: >-
85-
[e.g. Browser, tex or something else]
67+
Attempt to reproduce your error with the smallest set of extensions possible.
68+
This makes it easier to determine where the problem you are encountering is.
69+
70+
e.g. ["sphinx.ext.autodoc", "recommonmark"]
8671
validations:
8772
required: false
8873
- type: textarea
8974
attributes:
9075
label: Additional context
9176
description: >-
92-
Add any other context about the problem here.
93-
[e.g. URL or Ticket]
77+
Add any other context about the problem here, for example:
78+
79+
* Any other tools used (Browser, TeX, etc) with versions
80+
* Reference to another issue or pull request
81+
* URL to some external resource

0 commit comments

Comments
 (0)