Update issue/PR templates

This commit is contained in:
Henrik Lissner 2019-07-11 17:23:10 +02:00
parent dbcd2f7624
commit 8f186ae1f0
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395
10 changed files with 66 additions and 112 deletions

View file

@ -1,29 +1,33 @@
---
name: "Bug report"
about: "Something went wrong, please fix it!"
name: Bug report
about: Something went wrong, please fix it!
labels: is:bug
title: "[BUG] "
labels: "is:bug", "status:pending-review"
assignees: ''
---
**Describe the bug**
Begin with a short description of what the bug is.
**Describe the issue**
Start with a brief 1 or 2 sentence summary of issue.
Some tips on writing a good bug report:
- Explain what you expected to see and what actually happened
- Include screenshots/casts of your issue, if possible
- Add a link to your private config, if available
- Expand on phrases like "it does not work" and clarify what commands are bound
on non-default keybinds.
- Check your \*Messages\* buffer for warnings or errors (`SPC h e` or `M-x
Then follow with a longer explanation, if necessary. Here are some suggestions
on what to include:
- What you expected vs what actually happened
- Screenshots/casts of your issue
- A link to your private config
- Labels for any keys you reference (use `SPC h k` to inspect a key)
- Any warnings or errors logged to \*Messages\* (`SPC h e` or `M-x
view-echo-area-messages`).
- Include a backtrace of the error, if possible. To acquire a backtrace, first
you must turn on `debug-on-error` then recreate the error. To do so, either:
- Turn on debug mode on the fly with `M-x toggle-debug-on-error`,
- Start Emacs with `emacs --debug-init`
- Or, if the error occurred while using `bin/doom`, use the `-d` or `--debug`
switches, or the `DEBUG` environment variable.
- If the backtrace is especially long, put it in
<details><pre>...</pre></details> tags.
<details><pre>
If available, please a backtrace of the error here.
To acquire a backtrace, enable `debug-on-error` then recreate the error. Here
are ways to enable `debug-on-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>
**Steps to reproduce**
@ -35,5 +39,5 @@ Some tips on writing a good bug report:
**System information**
<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.
</pre></details>

View file

@ -1,19 +1,25 @@
---
name: "Feature Request"
about: "Make suggestions for improving Doom Emacs"
title: "[FEATURE] "
labels: "is:request", "status:pending-review"
name: Feature request
about: Make suggestions for improving Doom Emacs
labels: is:request
title: "[REQUEST] "
assignees: ''
---
**Describe the feature**
Summarize your suggestion or request.
Start with a brief 1 or 2 sentence summary of feature.
Include why it would be helpful and what type of user it would benefit most.
If this feature is implemented in another editor or Emacs distro, please include
screenshots or screencasts of it. If possible, include the names of the relevant
commands and not just the keybinds to invoke them. Links to their implementation
in source code would tremendously speed up processing of this request.
Then follow up with an extended explanation, if necessary. Here are some
suggestions on what to include:
- How is it helpful?
- How is the feature used?
- If the feature involves new plugins, include links to them
- iF the feature involves replacement of current functionality, describe how the
new functionality is better.
- If the feature is implemented in another editor Emacs distro:
- Include screenshots or screencasts of it
- Include links to its implementation
- Include names of commands (and not just the keybinds to invoke them)
**System information**

View file

@ -1,21 +1,21 @@
---
name: "How do I..."
about: "How to get Doom to behave a certain way"
name: How do I...
about: How to get Doom/Emacs to behave a certain way
labels: is:howto, status:pending-review
title: "[HOWTO] "
labels: "is:howto", "status:pending-review"
assignees: ''
---
**What I want to achieve**
Summarize what you are trying to do.
Start with a brief 1 or 2 sentence summary of what you're trying to achieve.
Follow up with an expanded explanation, if necessary. A few suggestions of what
you could include are:
- Code or steps you've tried that did not yield the results you wanted,
- Screenshots/casts of similar features in another editor or elsewhere,
- Code or steps you've tried that did not yield the results you wanted.
- Screenshots/casts of a proposed workflow in another editor or Emacs distro,
- Additional material or links to resources that could help clarify what you are
trying to do.
- A link to your private config, if it is available publicly.
- 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).

View file

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

12
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,12 @@
> To ensure that this PR is processed as quickly as possible, please ensure the
> following steps have been taken:
> - [ ] This PR targets the develop branch and not master
> - [ ] If your PR is a work in progress, include [WIP] in its title
> - [ ] Its commits' summaries are reasonably descriptive
> - [ ] You've described what this PR addresses below
> - [ ] You've included links to relevant issues, if any
> - [ ] You've deleted this template
>
> Thank you for contributing to Doom Emacs! <3
Your description here...

View file

@ -1,14 +0,0 @@
---
name: "Bug Fix"
about: "For fixing bugs originating from Doom"
title: "[BUGFIX] "
labels: "is:bug", "status:pending-review"
---
> This category is for bug fixes.
Thank you for contributing to Doom!
Before you submit this PR, please make sure it is targeted at the `develop`
branch and not `master`. Include links to relevant issues or, if the issue isn't
self-evident, describe the problem that is being fixed.

View file

@ -1,13 +0,0 @@
---
name: "Documentation"
about: "PRs that affect documentation files"
title: "[DOCS] "
labels: "re:docs", "status:pending-review"
---
> This category is for additions or corrections to Doom's documentation.
Thank you for contributing to Doom!
Before you submit this PR, please make sure it is targeted at the `develop`
branch and not `master`.

View file

@ -1,14 +0,0 @@
---
name: "New Feature"
about: "For new bells 'n whistles for old modules"
title: "[FEATURE] "
labels: "is:request", "status:pending-review"
---
> This category is for PRs that add features to pre-existing modules or Doom
> core.
Thank you for contributing to Doom!
Before you submit this PR, please make sure it is targeted at the `develop`
branch and not `master`.

View file

@ -1,15 +0,0 @@
---
name: "Maintenance"
about: "Minor corrections, refactors or bugfixes for changes upstream"
title: "[MAINTAIN] "
labels: "is:refactor", "status:pending-review"
---
> This category is for PRs that preform minor or cosmetic changes, refactors, or
> fixes for bugs introduced by changes upstream or elsewhere.
Thank you for contributing to Doom!
Before you submit this PR, please make sure it is targeted at the `develop`
branch and not `master`. Include links to relevant issues or, if the issue isn't
self-evident, describe the problem that is being fixed.

View file

@ -1,13 +0,0 @@
---
name: "New Module"
about: "For brand spankin' new modules"
title: "[MODULE] "
labels: "is:request", "re:module", "status:pending-review"
---
> This category is for PRs that add new modules.
Thank you for contributing to Doom!
Before you submit this PR, please make sure it is targeted at the `develop`
branch and not `master`.