mirror of
https://github.com/doomemacs/doomemacs.git
synced 2025-12-06 02:30:33 -08:00
a28d85e3e3
- Moves (and shortens) checklist to bottom so they don't hog content previews in Discord notifications (or notifications elsewhere). - Consolidate guidelines into a shorter list rather than checkboxes, because I've caught folks blindly checking them off too often. - Adds AI disclosure checkboxes. - Emphasize backtraces (because few posters remember to include them). - Revise to be a little more concise (hoping that less to skim will make folks more likely to read it, or at least grok it faster).
87 lines
4.5 KiB
YAML
87 lines
4.5 KiB
YAML
---
|
||
name: 📝 Bug Report
|
||
description: Report something that isn't working as intended
|
||
labels: ["is:bug", "needs-triage"]
|
||
projects: ["doomemacs/2"]
|
||
body:
|
||
- type: markdown
|
||
attributes:
|
||
value: |
|
||
> [!IMPORTANT]
|
||
> Before you fill out this bug report, please be aware of the following:
|
||
>
|
||
> - This is not the place for feature requests, general user support, PSAs, or discussions/RFCs. Those belong on [our Github discussion board](https://doomemacs.org/discuss) or [our Discord server](https://doomemacs.org/discord) — whichever you prefer.
|
||
> - Make sure your issue hasn't already been reported or addressed: search the issue tracker, [documentation](https://docs.doomemacs.org), [FAQ](https://docs.doomemacs.org/-/faq), [discussion board](https://doomemacs.org/discuss), and [Google](https://google.com).
|
||
> - Read [the debugging guide](https://discourse.doomemacs.org/t/55) for ways to extract more information from your issue.
|
||
> - Include [backtraces](https://discourse.doomemacs.org/t/85) for any reported error messages.
|
||
>
|
||
> Bug reports that are unactionable, vague, or too broad (or are otherwise unhelpful to posterity) **will be closed and queued for deletion**. Please understand that Emacs' complexity produces *many* false positives and open-ended bug reports that we lack the manpower to investigate at length, and keeping them around only pollutes search engines indices and makes it harder for users and maintainers to follow legitimate issues.
|
||
- type: textarea
|
||
attributes:
|
||
label: Describe your issue
|
||
description: |
|
||
Please try to include as much information as possible. Such as:
|
||
|
||
- **A [backtrace](https://discourse.doomemacs.org/t/85) for any error messages.**
|
||
- Any recent errors/warnings in the \*Messages\* buffer (`C-h e` to open it).
|
||
- Better explanations than "X does not work".
|
||
- Any attempts you made to resolve the issue yourself, and their result.
|
||
- Screenshots or screencasts, if possible.
|
||
|
||
**Take the time to properly format code and text dumps with [code fences](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) or use a [pastebin](https://pastebin.com) (or similar) service.**
|
||
placeholder: |
|
||
When I do X, it should do Y, but it does Z instead, which throws an error. Here is the backtrace:
|
||
|
||
```
|
||
Debugger entered--Lisp error: (error "Beep Boop")
|
||
error("Beep Boop")
|
||
pp-eval-expression((error "Beep Boop"))
|
||
\#<subr funcall-interactively>(pp-eval-expression (error "Beep Boop"))
|
||
apply(#<subr funcall-interactively> (pp-eval-expression (error "Beep Boop")))
|
||
funcall-interactively(pp-eval-expression (error "Beep Boop"))
|
||
```
|
||
validations:
|
||
required: true
|
||
- type: textarea
|
||
attributes:
|
||
label: Steps to reproduce
|
||
description: >
|
||
Walk us through a minimal test case. Please spell out any keybinds and assume the reader knows little about Doom and/or Emacs.
|
||
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"
|
||
validations:
|
||
required: true
|
||
- type: input
|
||
id: doominfo
|
||
attributes:
|
||
label: System information
|
||
description: |
|
||
Execute `M-x doom/info` or `$EMACSDIR/bin/doom info`, post their output to [pastebin](https://pastebin.com) (or a similar service with pastebins that don't expire), and paste the link to it below. **Please do not paste multi-line output directly into this text box! It pollutes our search engine results and makes it harder for others to find issues!**
|
||
placeholder: https://pastebin.com/fakeurl
|
||
validations:
|
||
required: true
|
||
- type: checkboxes
|
||
attributes:
|
||
label: Disclosures
|
||
description:
|
||
Please check off any that apply. These disclosures help us assess your issue(s) faster and more accurately.
|
||
options:
|
||
- label: >
|
||
This issue was written by AI.
|
||
- label: >
|
||
I used AI extensively to investigate this issue.
|
||
- label: >
|
||
My issue was observed on a stable and supported release of GNU Emacs (must not end in `.50`, `.60`, or `.90`–`.99`, e.g. `30.0.50`).
|
||
- label: >
|
||
A [backtrace](https://discourse.doomemacs.org/t/85) is provided for each error I've reported (if any).
|
||
required: true
|
||
- type: markdown
|
||
attributes:
|
||
value: |
|
||
-----
|
||
|
||
:heart: **Thank you for taking the time to file this bug report!**
|