emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

dev: revise issue/PR templates

Browse source 
Make them more concise and clearer.
This commit is contained in:
Henrik Lissner 2022-02-09 23:40:15 +01:00
parent 16fe83ef0e
commit fca870ee83
4 changed files with 104 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

65
.github/ISSUE_TEMPLATE/bug_report.yml vendored
View file

@ -6,17 +6,19 @@ body:
- type: markdown
attributes:
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:
+ [ ] Search [the FAQ](https://git.doomemacs.org/docs/faq.org) and [the documentation](https://git.doomemacs.org/docs/getting_started.org) for solutions.
+ [ ] Search [the issue tracker](https://github.com/hlissner/doom-emacs/issues) for similar issues (the closed issues too).
+ [ ] Search [the Discourse](https://discourse.doomemacs.org) for any errors and solutions.
+ [ ] Ensure the issue can be reproduced on [the latest commit](https://github.com/hlissner/doom-emacs/commit) of Doom Emacs.
+ [ ] 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.
- 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),
- Can be reproduced on the **latest commit** of Doom,
- Is reproducible on Emacs 27 or 28, _(Emacs 29 is not supported!)_
- 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),
- Is well-researched using [our troubleshooting guide](https://github.com/hlissner/doom-emacs/blob/master/docs/getting_started.org#troubleshoot).
- Has not been reported upstream (e.g. in the repos of any involved packages).
- type: textarea
attributes:
label: What did you expect to happen?
@ -27,12 +29,11 @@ body:
attributes:
label: What actually happened?
description: |
+ Include screenshots/casts, if possible
+ 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)
+ Include any suspicious logs in the **[\*Messages\*](https://doomemacs.org/d/t/55) buffer.
+ 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, error messages, and backtraces.**
+ Avoid phrases like "X does not work" or "X stopped working" without explaining what "working" means.
- Screenshots and gifs are a big help!
- Check the \*Messages\* buffer for errors and/or warnings (press `C-h e` to view this 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))
- **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!
- Be specific! Phrases like "X does not work" or "X stopped working" are unacceptable.
placeholder: |
When I do X, Z happened. Here is the backtrace:
@ -52,9 +53,9 @@ body:
attributes:
label: Describe your attempts to resolve the issue
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: |
I tried setting X to Y, then I tried Z. Here's what else I tried...
@ -64,7 +65,11 @@ body:
- type: textarea
attributes:
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: |
1. Open Emacs
2. `M-x doom/info` and be prompted to visit pastebin.com
@ -79,17 +84,29 @@ body:
attributes:
label: System Information
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: **Do not omit any part of or modify your doom/info.**
> :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,
> 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
validations:
required: true
- type: markdown
attributes:
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
View file

@ -6,18 +6,23 @@ body:
- type: markdown
attributes:
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+).
+ [ ] The target package(s) **are not** in [the do-not-PR list](https://gist.github.com/hlissner/bb6365626d825aeaf5e857b1c03c9837) list.
+ [ ] These packages haven't already been bumped on the [latest commit of Doom](https://github.com/hlissner/doom-emacs/commit).
+ [ ] The new versions of these packages work without issue.
- Haven't already been [requested](https://github.com/hlissner/doom-emacs/issues) or [PRed](https://github.com/hlissner/doom-emacs/pulls),
- *Is not* in [our do-not-PR list](https://gist.github.com/hlissner/bb6365626d825aeaf5e857b1c03c9837),
- Hasn't already been bumped in later commits of Doom,
- Still work with Doom on their latest commits.
- type: textarea
attributes:
label: What package(s) should be bumped?
@ -29,6 +34,24 @@ body:
attributes:
label: Why should Doom bump these packages early?
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: |
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
View file

@ -6,14 +6,15 @@ body:
- type: markdown
attributes:
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).
+ [ ] Search [the issue tracker](https://github.com/hlissner/doom-emacs/issues?q=label%3A%221.+request%22+) for similar requests.
+ [ ] Search [the module list](https://git.doomemacs.org/docs/modules.org) in case my feature was already implemented.
+ [ ] The request hasn't been fulfilled on [the latest commit of Doom](https://github.com/hlissner/doom-emacs/commit).
- Is a feature request and not a bug report,
- Hasn't already been requested or reported on [our issue tracker](https://github.com/hlissner/doom-emacs/issues),
- Hasn't already been fulfilled on the latest version of Doom or in [one of our modules](https://git.doomemacs.org/docs/modules.org).
- type: textarea
attributes:
label: Describe your request
@ -27,7 +28,9 @@ body:
attributes:
label: Briefly explain its use-case
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: |
1. Install Linux
2. Install Emacs
@ -40,4 +43,16 @@ body:
- type: markdown
attributes:
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
View file

@ -1,13 +1,15 @@
<!--
YOUR PR WILL NOT BE ACCEPTED IF IT DOES NOT MEET THE
FOLLOWING CRITERIA:
MAKE SURE YOUR PR MEETS THIS CRITERIA:
- [ ] No other pull requests exist for this issue
- [ ] Your PR targets the master branch (or rewrite-docs if changing org files)
- [ ] The issue is NOT in Doom's do-not-PR list: https://gist.github.com/hlissner/bb6365626d825aeaf5e857b1c03c9837
- [ ] Any relevant issues and PRs have been linked to
- [ ] Commit messages conform to our conventions: https://gist.github.com/hlissner/4d78e396acb897d9b2d8be07a103a854
* No other PRs exist for this issue.
* Your PR is NOT in Doom's do-not-PR list:
https://gist.github.com/hlissner/bb6365626d825aeaf5e857b1c03c9837
* Your commit messages conform to our git conventions:
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.
-->