Fix issue/PR templates & add sponsor button
Referenced in #1554, #1532, #1051
This commit is contained in:
parent
3423ecc3d3
commit
ead07dea83
14 changed files with 128 additions and 111 deletions
3
.github/FUNDING.yml
vendored
Normal file
3
.github/FUNDING.yml
vendored
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# github: hlissner
|
||||||
|
liberapay: hlissner
|
||||||
|
custom: https://paypal.me/henriklissner
|
39
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
39
.github/ISSUE_TEMPLATE/bug_report.md
vendored
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.
|
||||||
|
|
||||||
|
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
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
**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.
|
||||||
|
|
||||||
|
|
||||||
|
**System information**
|
||||||
|
<details><pre>
|
||||||
|
Include the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here.
|
||||||
|
</pre></details>
|
22
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
22
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
---
|
||||||
|
name: "Feature Request"
|
||||||
|
about: "Make suggestions for improving Doom Emacs"
|
||||||
|
title: "[FEATURE] "
|
||||||
|
labels: "is:request", "status:pending-review"
|
||||||
|
---
|
||||||
|
|
||||||
|
**Describe the feature**
|
||||||
|
Summarize your suggestion or request.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
**System information**
|
||||||
|
<details><pre>
|
||||||
|
Include the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here.
|
||||||
|
</pre></details>
|
26
.github/ISSUE_TEMPLATE/howto.md
vendored
Normal file
26
.github/ISSUE_TEMPLATE/howto.md
vendored
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
---
|
||||||
|
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**
|
||||||
|
Summarize what you are trying to do.
|
||||||
|
|
||||||
|
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,
|
||||||
|
- 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.
|
||||||
|
- The names of commands available in other Emacs distros (rather than just the
|
||||||
|
keybinds that invoke them).
|
||||||
|
|
||||||
|
|
||||||
|
**System information**
|
||||||
|
<details><pre>
|
||||||
|
Include the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here.
|
||||||
|
</pre></details>
|
|
@ -5,6 +5,4 @@ title: "[QUESTION] "
|
||||||
labels: "is:question", "status:pending-review"
|
labels: "is:question", "status:pending-review"
|
||||||
---
|
---
|
||||||
|
|
||||||
Start with a one-or-two sentence summary of your question.
|
What would you like to know?
|
||||||
|
|
||||||
Then follow with an expanded explanation...
|
|
14
.github/PULL_REQUEST_TEMPLATE/bug_fix.md
vendored
Normal file
14
.github/PULL_REQUEST_TEMPLATE/bug_fix.md
vendored
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
---
|
||||||
|
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.
|
|
@ -9,5 +9,5 @@ labels: "re:docs", "status:pending-review"
|
||||||
|
|
||||||
Thank you for contributing to Doom!
|
Thank you for contributing to Doom!
|
||||||
|
|
||||||
Before you submit this PR, please make sure it is targeted at `develop` and not
|
Before you submit this PR, please make sure it is targeted at the `develop`
|
||||||
`master`.
|
branch and not `master`.
|
14
.github/PULL_REQUEST_TEMPLATE/feature.md
vendored
Normal file
14
.github/PULL_REQUEST_TEMPLATE/feature.md
vendored
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
---
|
||||||
|
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`.
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
name: "Maintenance"
|
name: "Maintenance"
|
||||||
about: "Minor corrections, refactors or bugfixes for changes upstream"
|
about: "Minor corrections, refactors or bugfixes for changes upstream"
|
||||||
title: "[REFACTOR] "
|
title: "[MAINTAIN] "
|
||||||
labels: "is:refactor", "status:pending-review"
|
labels: "is:refactor", "status:pending-review"
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -10,6 +10,6 @@ labels: "is:refactor", "status:pending-review"
|
||||||
|
|
||||||
Thank you for contributing to Doom!
|
Thank you for contributing to Doom!
|
||||||
|
|
||||||
Before you submit this PR, please make sure it is targeted at `develop` and not
|
Before you submit this PR, please make sure it is targeted at the `develop`
|
||||||
`master`. Include links to relevant issues or, if the issue isn't self-evident,
|
branch and not `master`. Include links to relevant issues or, if the issue isn't
|
||||||
describe the problem that is being fixed.
|
self-evident, describe the problem that is being fixed.
|
|
@ -2,12 +2,12 @@
|
||||||
name: "New Module"
|
name: "New Module"
|
||||||
about: "For brand spankin' new modules"
|
about: "For brand spankin' new modules"
|
||||||
title: "[MODULE] "
|
title: "[MODULE] "
|
||||||
labels: "is:request", "re:modules", "status:pending-review"
|
labels: "is:request", "re:module", "status:pending-review"
|
||||||
---
|
---
|
||||||
|
|
||||||
> This category is for PRs that add new modules.
|
> This category is for PRs that add new modules.
|
||||||
|
|
||||||
Thank you for contributing to Doom!
|
Thank you for contributing to Doom!
|
||||||
|
|
||||||
Before you submit this PR, please make sure it is targeted at `develop` and not
|
Before you submit this PR, please make sure it is targeted at the `develop`
|
||||||
`master`.
|
branch and not `master`.
|
|
@ -1,39 +0,0 @@
|
||||||
---
|
|
||||||
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.
|
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
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.
|
|
|
@ -1,22 +0,0 @@
|
||||||
---
|
|
||||||
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.
|
|
|
@ -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 `develop` and not
|
|
||||||
`master`. Include links to relevant issues or, if the issue isn't self-evident,
|
|
||||||
describe the problem that is being fixed.
|
|
Loading…
Add table
Add a link
Reference in a new issue