Skip to content

Commit a3675ad

Browse files
committed
Update and rename bug_report.md to bug_report.yaml
change bug template
1 parent 7650c27 commit a3675ad

2 files changed

Lines changed: 68 additions & 30 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 30 deletions
This file was deleted.
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: "🐛 "
4+
labels: ["type: bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Before you start
10+
11+
- [Check for updates](https://github.com/ebullient/ttrpg-convert-cli/releases) and make sure you're running the latest version.
12+
- Look at existing bug reports to see if your issue has already been reported.
13+
- Is this actually a bug?
14+
- [Get Help](https://github.com/ebullient/ttrpg-convert-cli/tree/main#where-to-find-help) if you aren't confident you're doing things right.
15+
- If this is something that you wish the tool could do, start a discussion or create a feature request instead.
16+
17+
> [!NOTE]
18+
> Support for the 2024 Rule changes is experimental / in the snapshot at this time.
19+
> Messages you may see related to XPHB, XMM, XDMG, or HP formulas will be resolved when I have
20+
> more feedback from folks working with the snapshot to promote it. (There are a lot of changes)
21+
22+
- type: textarea
23+
id: the-problem
24+
attributes:
25+
label: Describe the bug
26+
description: |
27+
A clear and concise summary of what the bug is.
28+
29+
Include an example and/or specific details about the resource in question.
30+
validations:
31+
required: true
32+
33+
- type: markdown
34+
attributes:
35+
value: |
36+
Please provide a log file.
37+
38+
Run the command that exibits this bug as you usually would, but add the `--log` option.
39+
[Attach the `ttrpg-convert.out.txt` file](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files) that is created as a result.
40+
41+
- type: textarea
42+
id: expected
43+
attributes:
44+
label: Expected Behavior
45+
description: What did you expect to happen instead?
46+
validations:
47+
required: true
48+
49+
- type: input
50+
id: cli-version
51+
attributes:
52+
label: TTRPG CLI Version
53+
description: Which version are you using? (paste the output of [`--version`](https://github.com/ebullient/ttrpg-convert-cli/tree/7650c2785f05051fa64d95ec1f49d664ce4c2805#convert-5etools-json-data))
54+
placeholder: 2.3.18
55+
validations:
56+
required: true
57+
58+
- type: checkboxes
59+
id: operating-systems
60+
attributes:
61+
label: Which Operating Systems have you experienced this on?
62+
description: You may select more than one.
63+
options:
64+
- label: Android
65+
- label: iPhone/iPad
66+
- label: Linux
67+
- label: macOS
68+
- label: Windows

0 commit comments

Comments
 (0)