-
-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update and rename bug_report.md to bug_report.yaml
change bug template
- Loading branch information
Showing
2 changed files
with
83 additions
and
30 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
name: Bug Report | ||
description: File a bug report | ||
title: "🐛 " | ||
labels: ["type: bug"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
## Before you start | ||
- [Check for updates](https://github.com/ebullient/ttrpg-convert-cli/releases) and make sure you're running the latest version. | ||
- Look at existing bug reports to see if your issue has already been reported. | ||
- Is this actually a bug? | ||
- [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. | ||
- If this is something that you wish the tool could do, start a discussion or create a feature request instead. | ||
> [!NOTE] | ||
> Support for the 2024 Rule changes is experimental / in the snapshot at this time. | ||
> Messages you may see related to XPHB, XMM, XDMG, or HP formulas will be resolved when I have | ||
> more feedback from folks working with the snapshot to promote it. (There are a lot of changes) | ||
- type: textarea | ||
id: the-problem | ||
attributes: | ||
label: Describe the bug | ||
description: | | ||
A clear and concise summary of what the bug is. | ||
Include an example and/or specific details about the resource in question. | ||
validations: | ||
required: true | ||
|
||
- type: markdown | ||
attributes: | ||
value: | | ||
Please provide a log file. | ||
Run the command that exibits this bug as you usually would, but add the `--log` option. | ||
[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. | ||
- type: textarea | ||
id: expected | ||
attributes: | ||
label: Expected Behavior | ||
description: What did you expect to happen instead? | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: reproduce | ||
attributes: | ||
label: Steps to reproduce | ||
description: | | ||
Which exact steps can a developer take to reproduce the issue? | ||
The more detail you provide, the easier it will be to narrow down and fix the bug. | ||
placeholder: | | ||
1. Launch Obsidian Sandbox via the `Open Sandbox Vault` command. | ||
2. Install the plugin. | ||
3. Create a note with the above markdown snippet | ||
4. ... | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
id: cli-version | ||
attributes: | ||
label: TTRPG CLI Version | ||
description: Which version are you using? (paste the output of [`--version`](https://github.com/ebullient/ttrpg-convert-cli/tree/7650c2785f05051fa64d95ec1f49d664ce4c2805#convert-5etools-json-data)) | ||
placeholder: 2.3.18 | ||
validations: | ||
required: true | ||
|
||
- type: checkboxes | ||
id: operating-systems | ||
attributes: | ||
label: Which Operating Systems have you experienced this on? | ||
description: You may select more than one. | ||
options: | ||
- label: Android | ||
- label: iPhone/iPad | ||
- label: Linux | ||
- label: macOS | ||
- label: Windows |