Add new Issue & PR templates
This commit is contained in:
parent
eb47568701
commit
9fc87049ab
10 changed files with 150 additions and 35 deletions
39
docs/ISSUE_TEMPLATE/bug_report.md
Normal file
39
docs/ISSUE_TEMPLATE/bug_report.md
Normal file
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
name: "Bug report"
|
||||
about: "Something went wrong, please fix it!"
|
||||
title: "[BUG] "
|
||||
labels: "is:bug", "status:pending-review"
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
Begin with a short description of what the bug is.
|
||||
|
||||
If possible, include screen{shots,casts} and a link to your private config, if
|
||||
it is available publicly.
|
||||
|
||||
<details>
|
||||
<pre>
|
||||
If you received an error, paste the backtrace here.
|
||||
|
||||
To acquire a backtrace either:
|
||||
|
||||
1. Turn on debug mode with `M-x toggle-debug-on-error` or
|
||||
2. Start Emacs with `emacs --debug-init`
|
||||
3. Or, if the error occurred while using `bin/doom`, use the `-d` or `--debug`
|
||||
switch.
|
||||
|
||||
Then recreate the error and Emacs should produce a backtrace.
|
||||
</pre>
|
||||
</details>
|
||||
|
||||
**Steps to reproduce**
|
||||
1. Select these example steps,
|
||||
2. Delete them,
|
||||
3. And replace them with precise steps to reproduce your issue.
|
||||
4. Fill in "system information" below.
|
||||
|
||||
**Expected behavior**
|
||||
Describe what you expected to happen.
|
||||
|
||||
**System information**
|
||||
Paste the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here.
|
24
docs/ISSUE_TEMPLATE/feature_request.md
Normal file
24
docs/ISSUE_TEMPLATE/feature_request.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
name: "Feature Request"
|
||||
about: "Make suggestions for improving Doom Emacs"
|
||||
title: "[FEATURE] "
|
||||
labels: "is:request", "status:pending-review"
|
||||
---
|
||||
|
||||
**Describe the feature**
|
||||
Start with a one-or-two sentence summary of your suggestion or request.
|
||||
|
||||
Then follow with an expanded explanation. A few suggestions of what you could
|
||||
include here:
|
||||
|
||||
+ Why you think it would be helpful,
|
||||
+ Screenshots/casts of this feature in another editor or elsewhere,
|
||||
+ Links to any relevant packages.
|
||||
|
||||
**Relevant resources**
|
||||
Include links to relevant plugins, projects and/or websites.
|
||||
|
||||
**System information**
|
||||
Include the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here. It's
|
||||
possible that the feature you're requesting is already in Doom, but you haven't
|
||||
enabled it.
|
22
docs/ISSUE_TEMPLATE/howto.md
Normal file
22
docs/ISSUE_TEMPLATE/howto.md
Normal file
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
name: "How do I..."
|
||||
about: "How to get Doom to behave a certain way"
|
||||
title: "[HOWTO] "
|
||||
labels: "is:howto", "status:pending-review"
|
||||
---
|
||||
|
||||
**What I want to achieve**
|
||||
Start with a one-or-two sentence summary of what you are trying to do.
|
||||
|
||||
Then follow with an expanded explanation. A few suggestions of what you could
|
||||
include:
|
||||
|
||||
+ Code or steps you've tried that did not yield the results you wanted,
|
||||
+ Screenshots/casts of similar features in another editor or elsewhere,
|
||||
+ 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.
|
||||
|
||||
**System information**
|
||||
If it is pertinent to your goal, include the output of `M-x doom/info` or
|
||||
`~/.emacs.d/bin/doom info` here.
|
10
docs/ISSUE_TEMPLATE/question.md
Normal file
10
docs/ISSUE_TEMPLATE/question.md
Normal file
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
name: "Question"
|
||||
about: "A question about the project or maintainer"
|
||||
title: "[QUESTION] "
|
||||
labels: "is:question", "status:pending-review"
|
||||
---
|
||||
|
||||
Start with a one-or-two sentence summary of your question.
|
||||
|
||||
Then follow with an expanded explanation...
|
Loading…
Add table
Add a link
Reference in a new issue