Simplify github issue templates; correct labels

If they're too long, people won't read them.
If they're too short, people won't know what to do.
If there are too many of them, people can't decide which to use.

Removed the question template because it's redundant with "open a blank
issue".
This commit is contained in:
Henrik Lissner 2019-11-28 15:32:50 -05:00
parent 9bd8904838
commit ae80f1f67d
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395
4 changed files with 29 additions and 48 deletions

View file

@ -1,32 +1,26 @@
--- ---
name: Bug report name: Bug report
about: Something went wrong, please fix it! about: Doom might be misbehaving
labels: is:bug labels: is:bug
title: "[BUG] " title: "[BUG] "
assignees: '' assignees: ''
--- ---
**Describe the issue** **Describe the issue**
Start with a brief 1 or 2 sentence summary of issue. - What did you expect to happen?
- What actually happened?
Then follow with a longer explanation, if necessary. Here are some suggestions - Do you have screenshots/casts of your issue?
on what to include: - What commands are bound to any keys you've referenced? (use `SPC h k` to
- What you expected vs what actually happened inspect keys)
- Screenshots/casts of your issue - Can you include a link to your private config?
- A link to your private config - Were any warnings or errors logged to \*Messages\* (`SPC h e` or `M-x
- Labels for any keys you reference (use `SPC h k` to inspect a key) view-echo-area-messages` will open it).
- Any warnings or errors logged to \*Messages\* (`SPC h e` or `M-x
view-echo-area-messages`).
<details><pre> <details><pre>
If available, please a backtrace of the error here. Include a backtrace of the error.
To acquire a backtrace, enable `debug-on-error` then recreate the error. Here How to acquire a backtrace:
are ways to enable `debug-on-error`: https://github.com/hlissner/doom-emacs/blob/develop/docs/getting_started.org#how-to-extract-a-backtrace-from-an-error
- `M-x toggle-debug-on-error`,
- Start Emacs with `emacs --debug-init`
- If the error occurred while using `bin/doom`, use the `-d`/`--debug`
- switches or the `DEBUG` environment variable.
</pre></details> </pre></details>

View file

@ -1,22 +1,19 @@
--- ---
name: Feature request name: Feature request
about: Make suggestions for improving Doom Emacs about: It'd be cool if Doom did/had/would...
labels: is:request labels: is:request
title: "[REQUEST] " title: "[REQUEST] "
assignees: '' assignees: ''
--- ---
**Describe the feature** **Describe the feature**
Start with a brief 1 or 2 sentence summary of feature. - What is your request?
Then follow up with an extended explanation, if necessary. Here are some
suggestions on what to include:
- How is it helpful? - How is it helpful?
- How is the feature used? - How is it used?
- If the feature involves new plugins, include links to them - If the feature involves new plugins, include links to them
- iF the feature involves replacement of current functionality, describe how the - If the feature involves replacement of current functionality, how the new
new functionality is better. functionality is better?
- If the feature is implemented in another editor Emacs distro: - If the feature is implemented in another editor or Emacs distro:
- Include screenshots or screencasts of it - Include screenshots or screencasts of it
- Include links to its implementation - Include links to its implementation
- Include names of commands (and not just the keybinds to invoke them) - Include names of commands (and not just the keybinds to invoke them)
@ -25,4 +22,7 @@ suggestions on what to include:
**System information** **System information**
<details><pre> <details><pre>
Include the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here. Include the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here.
It's possible Doom already has the feature you're requesting. This will tell me
why you aren't seeing it.
</pre></details> </pre></details>

View file

@ -1,23 +1,19 @@
--- ---
name: How do I... name: How do I...
about: How to get Doom/Emacs to behave a certain way about: How to get Doom/Emacs to behave a certain way
labels: is:howto, status:pending-review labels: is:question
title: "[HOWTO] " title: "[HOWTO] "
assignees: '' assignees: ''
--- ---
**What I want to achieve** **What I want to achieve**
Start with a brief 1 or 2 sentence summary of what you're trying to achieve. - What are you trying to achieve?
- What have you tried?
Follow up with an expanded explanation, if necessary. A few suggestions of what - Do you have screenshots/casts of this workflow in another editor or Emacs
you could include are: distro? (If possible, include names of specific commands or functions from
- Code or steps you've tried that did not yield the results you wanted. other editors/kemacs distros)
- Screenshots/casts of a proposed workflow in another editor or Emacs distro, - Do you have extra material or links to resources that could help clarify what
- Additional material or links to resources that could help clarify what you are you are trying to do?
trying to do.
- A link to your private config, if available.
- The names of commands available in other Emacs distros (rather than just the
keybinds that invoke them).
**System information** **System information**

View file

@ -1,9 +0,0 @@
---
name: Question
about: A question about the project or maintainer
labels: is:question, status:pending-review
title: "[QUESTION] "
assignees: ''
---
What would you like to know?