Skip to content

Commit c647ab9

Browse files
committed
Convert the crash issue template to a form
1 parent 805eaf0 commit c647ab9

File tree

2 files changed

+68
-32
lines changed

2 files changed

+68
-32
lines changed

.github/ISSUE_TEMPLATE/01_crash.md

-32
This file was deleted.

.github/ISSUE_TEMPLATE/01_crash.yml

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: "Crash report"
2+
description: "rinohtype fails to produce a valid PDF file"
3+
labels: ["bug", "crash"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
Thanks for taking the time to fill out this bug report! ❤️
9+
10+
11+
Sometimes bugs have already been fixed in the master branch. Please try to
12+
reproduce the crash with the current master version of rinohtype before you
13+
file a bug report. You can install it directly from GitHub:
14+
15+
pip install https://github.com/brechtm/rinohtype/archive/refs/heads/master.zip
16+
17+
Please provide the following information to make your bug report as useful as
18+
possible.
19+
- type: checkboxes
20+
attributes:
21+
label: Is there an existing issue for this?
22+
description: Please search the issues to see if an issue already exists
23+
for the bug you encountered.
24+
options:
25+
- label: I have searched the existing issues
26+
required: true
27+
- type: textarea
28+
id: messages
29+
attributes:
30+
label: Sphinx or rinoh output
31+
description: The messages output by rinohtype (and Sphinx) when rendering
32+
the document.
33+
render: text
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: source
38+
attributes:
39+
label: Source files
40+
description: The Sphinx project files or inputs to rinoh that cause the crash.
41+
Please note that these are crucial for reproducing the crash! You
42+
can provide any additional information that may be useful here.
43+
placeholder: |
44+
- insert a link to the input files (e.g. a Sphinx project repository), or
45+
- attach an archive (e.g. zip) containing the source files
46+
47+
If you cannot share the source files publicly, try to create dummy input
48+
files that reproduce the bug (may be difficult). Alternatively, you can send
49+
the input files to me privately at [email protected] (I will not share them
50+
with others, of course).
51+
validations:
52+
required: true
53+
- type: textarea
54+
id: versions
55+
attributes:
56+
label: Versions
57+
description: Version information for rinohtype, Sphinx, Python and your operating system
58+
placeholder: |
59+
Paste the output of `rinoh --versions` (trailing _s_!), for rinohtype >= 0.5.4
60+
61+
Otherwise, the output of:
62+
rinoh --version
63+
sphinx-build --version
64+
python --version
65+
python -c "import platform; print(platform.platform())"
66+
render: text
67+
validations:
68+
required: true

0 commit comments

Comments
 (0)