Skip to content

Commit a2aac62

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

File tree

2 files changed

+70
-30
lines changed

2 files changed

+70
-30
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 30 deletions
This file was deleted.
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
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+
> [!TIP]
18+
>
19+
> - 🚜 [**Review the changelog**](https://github.com/ebullient/ttrpg-convert-cli/blob/main/CHANGELOG.md) for new capabilities (✨) and breaking changes (🔥💥).
20+
> - 🔮 Check out [**Conventions**](https://github.com/ebullient/ttrpg-convert-cli/blob/main/README.md#conventions) and [**Recommendations**](https://github.com/ebullient/ttrpg-convert-cli/blob/main/README.md#recommendations-for-using-the-cli).
21+
> - 🔥 Support for the 5e 2024 ruleset is [in progress](https://github.com/ebullient/ttrpg-convert-cli/discussions/586).
22+
> Messages you may see related to XPHB, XMM, XDMG, or HP formulas are all related to this change
23+
24+
- type: textarea
25+
id: the-problem
26+
attributes:
27+
label: Describe the bug
28+
description: |
29+
A clear and concise summary of what the bug is.
30+
31+
Include an example and/or specific details about the resource in question.
32+
validations:
33+
required: true
34+
35+
- type: markdown
36+
attributes:
37+
value: |
38+
Please provide a log file.
39+
40+
Run the command that exibits this bug as you usually would, but add the `--log` option.
41+
[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.
42+
43+
- type: textarea
44+
id: expected
45+
attributes:
46+
label: Expected Behavior
47+
description: What did you expect to happen instead?
48+
validations:
49+
required: true
50+
51+
- type: input
52+
id: cli-version
53+
attributes:
54+
label: TTRPG CLI Version
55+
description: Which version are you using? (paste the output of [`--version`](https://github.com/ebullient/ttrpg-convert-cli/tree/7650c2785f05051fa64d95ec1f49d664ce4c2805#convert-5etools-json-data))
56+
placeholder: 2.3.18
57+
validations:
58+
required: true
59+
60+
- type: checkboxes
61+
id: operating-systems
62+
attributes:
63+
label: Which Operating Systems have you experienced this on?
64+
description: You may select more than one.
65+
options:
66+
- label: Android
67+
- label: iPhone/iPad
68+
- label: Linux
69+
- label: macOS
70+
- label: Windows

0 commit comments

Comments
 (0)