Replace bug_report issue template with form
This commit is contained in:
Henrik Lissner
parent
92a378c8d0
commit
9cc7e3ac7d
2 changed files with 82 additions and 48 deletions
48
.github/ISSUE_TEMPLATE/bug_report.md
vendored
48
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -1,48 +0,0 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Doom might be misbehaving
|
||||
---
|
||||
<!--
|
||||
Please take the time to write a detailed bug report. Your issue will be
|
||||
automatically deleted if it is too vague or fails to adhere to this template
|
||||
without good reason.
|
||||
-->
|
||||
|
||||
**What did you expect to happen?**
|
||||
...
|
||||
|
||||
|
||||
**What actually happened?**
|
||||
...
|
||||
|
||||
|
||||
**Additional details:**
|
||||
<!--
|
||||
- Link to your private config, if possible
|
||||
- Include screenshots/casts of your issue
|
||||
- Replace key sequences in your steps to reproduce, use commands
|
||||
- Include any warnings or errors logged to \*Messages\* (use `M-x
|
||||
view-echo-area-messages` to see it).
|
||||
- If an error message is involved produce a backtrace of it, copy it to
|
||||
pastebin.com, and post the link here.
|
||||
|
||||
How to acquire a backtrace:
|
||||
https://doomemacs.org/docs/getting_started.org#how-to-extract-a-backtrace-from-an-error
|
||||
-->
|
||||
|
||||
|
||||
**Steps to reproduce:**
|
||||
1. Select these example steps,
|
||||
2. Delete them,
|
||||
3. Replace them with precise steps to reproduce your issue.
|
||||
4. Include code samples, keybinds, and commands.
|
||||
5. Please don't skimp on details.
|
||||
6. Then fill in "system information" below or this issue will be deleted.
|
||||
|
||||
|
||||
**System information:**
|
||||
<!--
|
||||
1. Grab output from `M-x doom/info` or `~/.emacs.d/bin/doom info`,
|
||||
2. Paste it into pastebin.com,
|
||||
3. Paste URL above this commented block.
|
||||
-->
|
||||
82
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
82
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
|
|
@ -0,0 +1,82 @@
|
|||
---
|
||||
name: 📝 Report a bug, error, or misbehavior
|
||||
labels: ["1. bug", "2. status:unread"]
|
||||
body:
|
||||
- type: markdown
|
||||
value: |
|
||||
**Thank you for reporting an issue to our issue tracker!**
|
||||
|
||||
> **Tip:** If you are seeking support or usage advice, head over [our Discord](https://doomemacs.org/discord) or [our Discourse](https://discourse.doomemacs.org) instead.
|
||||
|
||||
Before you fill out the form, please consult our available resources and collect as much information about your issue as possible:
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
options:
|
||||
# - label: I have read the [contributing guide](https://discourse.doomemacs.org/how2contribute).
|
||||
# required: true
|
||||
- label: I have searched [the FAQ](https://doomemacs.org/docs/faq.org) and [the documentation](https://doomemacs.org/docs/getting_started.org) for solutions.
|
||||
required: true
|
||||
- label: I have searched [the issue tracker](https://github.com/hlissner/doom-emacs/issues) for similar issues (the closed issues too).
|
||||
required: true
|
||||
- label: I can reproduce my issue on [the latest commit](https://github.com/hlissner/doom-emacs/commit) of Doom Emacs.
|
||||
required: true
|
||||
# - label: I have searched [the Discourse](https://discourse.doomemacs.org/docs) for solutions.
|
||||
# required: true
|
||||
# - label: I have read [How to Debug Issues](https://discourse.doomemacs.org/how2debug) and found no solution.
|
||||
# required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: What did you expect to happen?
|
||||
description: |
|
||||
_Please use [code fences](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) for code, log output, and backtraces._
|
||||
placeholder: When I do X, it should do Y.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: What actually happened?
|
||||
description: |
|
||||
Include screenshots/casts, logs, and [backtraces for errors](https://discourse.doomemacs.org/how2backtrace), if possible.
|
||||
|
||||
_Please use [code fences](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) for code, log output, and backtraces._
|
||||
placeholder: |
|
||||
When I do X, Z happened! Here are the details...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Describe your attempts to resolve the issue
|
||||
description: |
|
||||
Describe resources you consulted or code you tried to fix your problem, and their result.
|
||||
|
||||
_Please use [code fences](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) for code, log output, and backtraces._
|
||||
placeholder: |
|
||||
I tried setting X to Y, then I tried Z. Here's what else I tried...
|
||||
|
||||
```elisp
|
||||
(setq variable value)
|
||||
```
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: How do we reproduce your issue? Please walk us through a minimal test case.
|
||||
placeholder: |
|
||||
1. Open Emacs
|
||||
2. `M-x doom/info` and be prompted to visit pastebin.com
|
||||
3. Press `y` to open pastebin.com in browser
|
||||
4. Paste the contents of my clipboard into text box
|
||||
5. Click "Create New Paste"
|
||||
6. My wife leaves me
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: doominfo
|
||||
attributes:
|
||||
label: System Information
|
||||
description: |
|
||||
Upload the output of `M-x doom/info` or `$ ~/.emacs.d/bin/doom info` **to [pastebin.com](https://pastebin.com)**, then paste its URL here.
|
||||
|
||||
The use of pastebin (or a similar service) is necessary to reduce search result pollution in our issue tracker.
|
||||
placeholder: https://pastebin.com/fakeurl
|
||||
validations:
|
||||
required: true
|
||||
Loading…
Add table
Add a link
Reference in a new issue