dev: revise issue/PR templates
Make them more concise and clearer.
This commit is contained in:
parent
16fe83ef0e
commit
fca870ee83
4 changed files with 104 additions and 47 deletions
65
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
65
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
@ -6,17 +6,19 @@ body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
> :warning: **Our issue tracker is not for how-to or configuration questions.** Please post those on [our Discord](https://doomemacs.org/discord).
|
> :warning: **Our issue tracker is for bug reports and feature requests,
|
||||||
|
> not configuration questions or requests for help.** Use [our
|
||||||
|
> Discord](https://doomemacs.org/discord) for those instead.
|
||||||
|
|
||||||
**Before you proceed...**
|
**Before you proceed, please ensure your issue:**
|
||||||
|
|
||||||
We depend on you to ensure your issue hasn't already been addressed, isn't covered by documentation, and isn't caused by personal configuration. To help us rule out these possibilities please follow these guidelines:
|
- Wasn't already reported on [our issue tracker](https://github.com/hlissner/doom-emacs/issues),
|
||||||
|
- Hasn't been covered by [our FAQ](https://github.com/hlissner/doom-emacs/blob/develop/docs/faq.org),
|
||||||
+ [ ] Search [the FAQ](https://git.doomemacs.org/docs/faq.org) and [the documentation](https://git.doomemacs.org/docs/getting_started.org) for solutions.
|
- Can be reproduced on the **latest commit** of Doom,
|
||||||
+ [ ] Search [the issue tracker](https://github.com/hlissner/doom-emacs/issues) for similar issues (the closed issues too).
|
- Is reproducible on Emacs 27 or 28, _(Emacs 29 is not supported!)_
|
||||||
+ [ ] Search [the Discourse](https://discourse.doomemacs.org) for any errors and solutions.
|
- Is reproducible in [vanilla Doom](https://github.com/hlissner/doom-emacs/blob/develop/docs/getting_started.org#testing-in-dooms-sandbox) (i.e. with your private config disabled),
|
||||||
+ [ ] Ensure the issue can be reproduced on [the latest commit](https://github.com/hlissner/doom-emacs/commit) of Doom Emacs.
|
- Is well-researched using [our troubleshooting guide](https://github.com/hlissner/doom-emacs/blob/master/docs/getting_started.org#troubleshoot).
|
||||||
+ [ ] Consult [our troubleshooting](https://github.com/hlissner/doom-emacs/blob/master/docs/getting_started.org#troubleshoot) on techniques to get more information and, possibly, solve the issue yourself.
|
- Has not been reported upstream (e.g. in the repos of any involved packages).
|
||||||
- type: textarea
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: What did you expect to happen?
|
label: What did you expect to happen?
|
||||||
|
@ -27,12 +29,11 @@ body:
|
||||||
attributes:
|
attributes:
|
||||||
label: What actually happened?
|
label: What actually happened?
|
||||||
description: |
|
description: |
|
||||||
+ Include screenshots/casts, if possible
|
- Screenshots and gifs are a big help!
|
||||||
+ List *all* error messages and **[include backtraces for each of them](https://github.com/hlissner/doom-emacs/blob/master/docs/getting_started.org#how-to-extract-a-backtrace-from-an-error)
|
- Check the \*Messages\* buffer for errors and/or warnings (press `C-h e` to view this buffer).
|
||||||
+ Include any suspicious logs in the **[\*Messages\*](https://doomemacs.org/d/t/55) buffer.
|
- **Always include backtraces for errors.** ([How to produce a backtrace](https://github.com/hlissner/doom-emacs/blob/master/docs/getting_started.org#how-to-extract-a-backtrace-from-an-error))
|
||||||
+ If you include log dumps, please use [pastebin.com](https://pastebin.com)
|
- **Use [code fences](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) for code, logs, or text dumps!** Or use pastebin.com!
|
||||||
+ **Use [code fences](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) for code, error messages, and backtraces.**
|
- Be specific! Phrases like "X does not work" or "X stopped working" are unacceptable.
|
||||||
+ Avoid phrases like "X does not work" or "X stopped working" without explaining what "working" means.
|
|
||||||
placeholder: |
|
placeholder: |
|
||||||
When I do X, Z happened. Here is the backtrace:
|
When I do X, Z happened. Here is the backtrace:
|
||||||
|
|
||||||
|
@ -52,9 +53,9 @@ body:
|
||||||
attributes:
|
attributes:
|
||||||
label: Describe your attempts to resolve the issue
|
label: Describe your attempts to resolve the issue
|
||||||
description: |
|
description: |
|
||||||
Describe resources you consulted or code you tried to fix your problem, and their result.
|
How have you tried to fix your issue? What was the result?
|
||||||
|
|
||||||
**HINT: Remember to use [code fences](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) for code, log output, and backtraces.**
|
_(Hint: use [code fences](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) for code or text dumps!)_
|
||||||
placeholder: |
|
placeholder: |
|
||||||
I tried setting X to Y, then I tried Z. Here's what else I tried...
|
I tried setting X to Y, then I tried Z. Here's what else I tried...
|
||||||
|
|
||||||
|
@ -64,7 +65,11 @@ body:
|
||||||
- type: textarea
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Steps to reproduce
|
label: Steps to reproduce
|
||||||
description: How do we reproduce your issue? Walk us through a minimal test case.
|
description: |
|
||||||
|
How do we reproduce your issue? Walk us through a minimal test case.
|
||||||
|
|
||||||
|
> :warning: This is required! If you can't offer steps to reproduce it,
|
||||||
|
> the issue will be immediately closed!
|
||||||
placeholder: |
|
placeholder: |
|
||||||
1. Open Emacs
|
1. Open Emacs
|
||||||
2. `M-x doom/info` and be prompted to visit pastebin.com
|
2. `M-x doom/info` and be prompted to visit pastebin.com
|
||||||
|
@ -79,17 +84,29 @@ body:
|
||||||
attributes:
|
attributes:
|
||||||
label: System Information
|
label: System Information
|
||||||
description: |
|
description: |
|
||||||
Paste a link to a [pastebin](https://pastebin.com) where you've uploaded the output of `M-x doom/info` or `$ ~/.emacs.d/bin/doom info`.
|
Provide a [pastebin.com](https://pastebin.com) link to the output of `M-x
|
||||||
|
doom/info` or `$ ~/.emacs.d/bin/doom info`.
|
||||||
|
|
||||||
> :warning: **Do not paste your M-x doom/info directly into this box!** Use pastebin to minimize search result pollution in our issue tracker.
|
> :warning: **This _must_ be a pastebin.com link.** Please don't use any
|
||||||
|
> other service, please don't paste your doom-info directly into this box,
|
||||||
> :warning: **Do not omit any part of or modify your doom/info.**
|
> and please don't omit it. If you can't provide it, **please explain why
|
||||||
|
> in the box below or other fields above!**
|
||||||
placeholder: https://pastebin.com/fakeurl
|
placeholder: https://pastebin.com/fakeurl
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Before you go, please make sure your report's title is descriptive and specific. Avoid phrases like "X doesn't work" or "X stopped working". Error messages are best, but failing that, try to describe what "working" means to you.
|
Please take a moment to ensure your issue (and it's title) is
|
||||||
|
**well-researched, descriptive, and specific**, otherwise, you risk it
|
||||||
|
being significantly delayed or automatically closed.
|
||||||
|
|
||||||
**Thank you for taking the time to fill out a bug report!**
|
Emacs' complexity and extensibility produces many false positive or vague
|
||||||
|
bug reports, so I will immediately close issues that aren't
|
||||||
|
**actionable**, **reproducible in vanilla Doom**, or able to be
|
||||||
|
investigated in a **reasonable amount of time**.
|
||||||
|
|
||||||
|
If you don't think your issue qualifies, please bring it up on [our
|
||||||
|
Discord](https://doomemacs.org/discord) instead.
|
||||||
|
|
||||||
|
:heart: **Thank you for taking the time to file this bug report!**
|
||||||
|
|
39
.github/ISSUE_TEMPLATE/bump_request.yml
vendored
39
.github/ISSUE_TEMPLATE/bump_request.yml
vendored
|
@ -6,18 +6,23 @@ body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Doom pins its packages to certain commits to avoid breaking updates and to help its maintainer keep up with changes. These pins are updated (bumped) frequently, usually every other week, but some may warrant an early bump, due to critical bug fixes or to adapt to external events.
|
Doom pins its packages to certain commits to avoid breaking updates and
|
||||||
|
help its maintainer keep up with changes. These pins are updated (bumped)
|
||||||
|
frequently, usually every other week, but sometimes I'll fall behind,
|
||||||
|
either due to life:tm: or upstream issues. Other times, a package may
|
||||||
|
introduce critical fixes I should be made aware of.
|
||||||
|
|
||||||
Use this form to let us know about these packages.
|
Use this form to let me know about these updates.
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
**Before you submit this bump request, make sure...**
|
**Before you submit this bump request, please ensure that the target
|
||||||
|
packages:**
|
||||||
|
|
||||||
+ [ ] To search for any open (or closed) [bump requests for this package](https://github.com/hlissner/doom-emacs/pulls?q=is%3Apr+is%3Aopen+label%3A%221.+update%29%22+).
|
- Haven't already been [requested](https://github.com/hlissner/doom-emacs/issues) or [PRed](https://github.com/hlissner/doom-emacs/pulls),
|
||||||
+ [ ] The target package(s) **are not** in [the do-not-PR list](https://gist.github.com/hlissner/bb6365626d825aeaf5e857b1c03c9837) list.
|
- *Is not* in [our do-not-PR list](https://gist.github.com/hlissner/bb6365626d825aeaf5e857b1c03c9837),
|
||||||
+ [ ] These packages haven't already been bumped on the [latest commit of Doom](https://github.com/hlissner/doom-emacs/commit).
|
- Hasn't already been bumped in later commits of Doom,
|
||||||
+ [ ] The new versions of these packages work without issue.
|
- Still work with Doom on their latest commits.
|
||||||
- type: textarea
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: What package(s) should be bumped?
|
label: What package(s) should be bumped?
|
||||||
|
@ -29,6 +34,24 @@ body:
|
||||||
attributes:
|
attributes:
|
||||||
label: Why should Doom bump these packages early?
|
label: Why should Doom bump these packages early?
|
||||||
description: |
|
description: |
|
||||||
Briefly describe what has changed, and why they warrant an early bump. Link any relevant commits or issues, if possible. Mention anything Doom may have to change to accommodate it.
|
What has changed, upstream? Why do those changes warrant an early bump?
|
||||||
|
Link any relevant commits or issues, if possible. Mention anything Doom
|
||||||
|
may have to change to accommodate it.
|
||||||
placeholder: |
|
placeholder: |
|
||||||
Recent changes to X have fixed several open issues in Y and Z, but have broken A and B in Doom.
|
Recent changes to X have fixed several open issues in Y and Z, but have broken A and B in Doom.
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
Please take a moment to ensure your bump request is **well-researched,
|
||||||
|
descriptive, and specific**, otherwise, you risk it being significantly
|
||||||
|
delayed or automatically closed.
|
||||||
|
|
||||||
|
Emacs' complexity and extensibility produces many false positive or vague
|
||||||
|
requests, so I will immediately close issues that aren't **actionable**,
|
||||||
|
**poorly explained**, or able to be investigated in a reasonable amount of
|
||||||
|
**time**.
|
||||||
|
|
||||||
|
If you don't think your request qualifies, please bring it up on [our
|
||||||
|
Discord](https://doomemacs.org/discord) instead.
|
||||||
|
|
||||||
|
:heart: **Thank you for taking the time to make this bump request!**
|
||||||
|
|
31
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
31
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
|
@ -6,14 +6,15 @@ body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
> :warning: **Our issue tracker is not for how-to or configuration questions.** Please post those on [our Discord](https://doomemacs.org/discord) or [Discourse](https://discourse.doomemacs.org) instead.
|
> :warning: **Our issue tracker is for bug reports and feature requests,
|
||||||
|
> not configuration questions or requests for help.** Use [our
|
||||||
|
> Discord](https://doomemacs.org/discord) for those instead.
|
||||||
|
|
||||||
**Before you proceed, to rule out the possibility that your request has already been made (or fulfilled), please follow these guidelines:**
|
**Before you proceed, please ensure your request:**
|
||||||
|
|
||||||
+ [ ] Read the [contributing guidelines](https://git.doomemacs.org/docs/contributing.org).
|
- Is a feature request and not a bug report,
|
||||||
+ [ ] Search [the issue tracker](https://github.com/hlissner/doom-emacs/issues?q=label%3A%221.+request%22+) for similar requests.
|
- Hasn't already been requested or reported on [our issue tracker](https://github.com/hlissner/doom-emacs/issues),
|
||||||
+ [ ] Search [the module list](https://git.doomemacs.org/docs/modules.org) in case my feature was already implemented.
|
- Hasn't already been fulfilled on the latest version of Doom or in [one of our modules](https://git.doomemacs.org/docs/modules.org).
|
||||||
+ [ ] The request hasn't been fulfilled on [the latest commit of Doom](https://github.com/hlissner/doom-emacs/commit).
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Describe your request
|
label: Describe your request
|
||||||
|
@ -27,7 +28,9 @@ body:
|
||||||
attributes:
|
attributes:
|
||||||
label: Briefly explain its use-case
|
label: Briefly explain its use-case
|
||||||
description: |
|
description: |
|
||||||
A screencast is ideal, but a list of steps and effects showing off how it would work is acceptable.
|
How would your requested feature be used? Can you demonstrate it with a
|
||||||
|
screencast of another editor? List the steps a typical user would take to
|
||||||
|
use it, were it added to Doom.
|
||||||
placeholder: |
|
placeholder: |
|
||||||
1. Install Linux
|
1. Install Linux
|
||||||
2. Install Emacs
|
2. Install Emacs
|
||||||
|
@ -40,4 +43,16 @@ body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
**Thank you for taking the time to fill out a feature request!**
|
Please take a moment to ensure your feature request (and it's title) is
|
||||||
|
**well-researched, descriptive, and specific**, otherwise, you risk it
|
||||||
|
being significantly delayed or automatically closed.
|
||||||
|
|
||||||
|
Emacs' complexity and extensibility produces many false positive or vague
|
||||||
|
requests, so I will immediately close issues that aren't **actionable**,
|
||||||
|
**poorly explained**, or able to be investigated in a reasonable amount of
|
||||||
|
**time**.
|
||||||
|
|
||||||
|
If you don't think your request qualifies, please bring it up on [our
|
||||||
|
Discord](https://doomemacs.org/discord) instead.
|
||||||
|
|
||||||
|
:heart: **Thank you for taking the time to make this feature request!**
|
||||||
|
|
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
@ -1,13 +1,15 @@
|
||||||
<!--
|
<!--
|
||||||
|
|
||||||
YOUR PR WILL NOT BE ACCEPTED IF IT DOES NOT MEET THE
|
MAKE SURE YOUR PR MEETS THIS CRITERIA:
|
||||||
FOLLOWING CRITERIA:
|
|
||||||
|
|
||||||
- [ ] No other pull requests exist for this issue
|
* No other PRs exist for this issue.
|
||||||
- [ ] Your PR targets the master branch (or rewrite-docs if changing org files)
|
* Your PR is NOT in Doom's do-not-PR list:
|
||||||
- [ ] The issue is NOT in Doom's do-not-PR list: https://gist.github.com/hlissner/bb6365626d825aeaf5e857b1c03c9837
|
https://gist.github.com/hlissner/bb6365626d825aeaf5e857b1c03c9837
|
||||||
- [ ] Any relevant issues and PRs have been linked to
|
* Your commit messages conform to our git conventions:
|
||||||
- [ ] Commit messages conform to our conventions: https://gist.github.com/hlissner/4d78e396acb897d9b2d8be07a103a854
|
https://gist.github.com/hlissner/4d78e396acb897d9b2d8be07a103a854
|
||||||
|
* Your PR targets the master branch (or the rewrite-docs branch for changes to
|
||||||
|
*.org files).
|
||||||
|
* Any relevant issues or PRs have been linked to.
|
||||||
|
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue