Update issue/PR templates

This commit is contained in:
Henrik Lissner 2019-12-12 01:26:14 -05:00
parent 6ff31408ec
commit 0b11184e2d
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395
4 changed files with 39 additions and 33 deletions

View file

@ -6,32 +6,38 @@ title: "[BUG] "
assignees: '' assignees: ''
--- ---
**Describe the issue** **What did you expect to happen?**
- What did you expect to happen? ...
- What actually happened?
- Do you have screenshots/casts of your issue?
- What commands are bound to any keys you've referenced? (use `SPC h k` to **What actually happened?**
inspect keys) ...
- Can you include a link to your private config?
- Were any warnings or errors logged to \*Messages\* (`SPC h e` or `M-x
view-echo-area-messages` will open it). **Additional details:**
- Include a link to your private config
- Include screenshots/casts of your issue
- If you mention key sequences, include what commands they're bound to (use `SPC
h k KEY` or `C-h h k KEY` to inspect keys).
- Include any warnings or errors logged to \*Messages\* (use `M-x
view-echo-area-messages` to see it).
<details><pre> <details><pre>
Include a backtrace of the error. If an error message is involved include a backtrace of it.
How to acquire a backtrace: How to acquire a backtrace:
https://github.com/hlissner/doom-emacs/blob/develop/docs/getting_started.org#how-to-extract-a-backtrace-from-an-error https://github.com/hlissner/doom-emacs/blob/develop/docs/getting_started.org#how-to-extract-a-backtrace-from-an-error
</pre></details> </pre></details>
**Steps to reproduce** **Steps to reproduce:**
1. Select these example steps, 1. Select these example steps,
2. Delete them, 2. Delete them,
3. And replace them with precise steps to reproduce your issue. 3. And replace them with precise steps to reproduce your issue.
4. Fill in "system information" below. 4. Fill in "system information" below.
**System information** **System information:**
<details><pre> <details><pre>
Place the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here. Place the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here.
</pre></details> </pre></details>

View file

@ -1,28 +1,22 @@
--- ---
name: Feature request name: Feature request
about: It'd be cool if Doom did/had/would... about: It'd be cool if Doom did/had/would...
labels: is:request labels: is:new
title: "[REQUEST] " title: "[REQUEST] "
assignees: '' assignees: ''
--- ---
**Describe the feature** **Describe the feature**
- What is your request?
- How is it helpful?
- 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, how the new - If the feature involves replacement of current functionality, how the new
functionality is better? functionality is better?
- If the feature is implemented in another editor or Emacs distro: - If the feature is implemented in another editor or Emacs distro, include:
- Include screenshots or screencasts of it - Screenshots or screencasts of it
- Include links to its implementation - Links to its implementation
- Include names of commands (and not just the keybinds to invoke them) - Names of relevant commands (and not only the keybinds to invoke them)
**System information** **System information**
<details><pre> <details><pre>
Include the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here. Place 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

@ -6,14 +6,20 @@ title: "[HOWTO] "
assignees: '' assignees: ''
--- ---
**What I want to achieve** **What are you trying to achieve?**
- What are you trying to achieve? ...
- What have you tried?
**What have you tried?**
...
**Additional information**
- Do you have screenshots/casts of this workflow in another editor or Emacs - Do you have screenshots/casts of this workflow in another editor or Emacs
distro? (If possible, include names of specific commands or functions from distro? (If possible, include names of specific commands or functions from
other editors/kemacs distros) other editors/emacs distros)
- Do you have extra material or links to resources that could help clarify what - Do you have additional material or links to resources that could help clarify
you are trying to do? what you are trying to do?
**System information** **System information**

View file

@ -1,6 +1,6 @@
> To ensure that this PR is processed as quickly as possible, please ensure the > Please follow these steps before submitting your PR:
> following steps have been taken: >
> - [ ] This PR targets the develop branch and not master > - [ ] This PR targets the `develop` branch and not `master`
> - [ ] If your PR is a work in progress, include [WIP] in its title > - [ ] If your PR is a work in progress, include [WIP] in its title
> - [ ] Its commits' summaries are reasonably descriptive > - [ ] Its commits' summaries are reasonably descriptive
> - [ ] You've described what this PR addresses below > - [ ] You've described what this PR addresses below