dev: fix formatting in issue form templates

This commit is contained in:
Henrik Lissner 2022-02-20 03:36:35 +01:00
parent 849672691d
commit a2b931e4c9
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
3 changed files with 17 additions and 51 deletions

View file

@ -68,8 +68,7 @@ body:
description: | description: |
How do we reproduce your issue? Walk us through a minimal test case. 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, > :warning: This is required! If you can't offer steps to reproduce it, the issue will be immediately closed!
> 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
@ -84,29 +83,19 @@ body:
attributes: attributes:
label: System Information label: System Information
description: | description: |
Provide a [pastebin.com](https://pastebin.com) link to the output of `M-x Provide a [pastebin.com](https://pastebin.com) link to the output of `M-x doom/info` or `$ ~/.emacs.d/bin/doom info`.
doom/info` or `$ ~/.emacs.d/bin/doom info`.
> :warning: **This _must_ be a pastebin.com link.** Please don't use any > :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!**
> 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 placeholder: https://pastebin.com/fakeurl
validations: validations:
required: true required: true
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Please take a moment to ensure your issue (and it's title) is 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.
**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 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**.
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 If you don't think your issue qualifies, please bring it up on [our Discord](https://doomemacs.org/discord) instead.
Discord](https://doomemacs.org/discord) instead.
:heart: **Thank you for taking the time to file this bug report!** :heart: **Thank you for taking the time to file this bug report!**

View file

@ -6,18 +6,13 @@ body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Doom pins its packages to certain commits to avoid breaking updates and 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.
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 me know about these updates. Use this form to let me know about these updates.
----- -----
**Before you submit this bump request, please ensure that the target **Before you submit this bump request, please ensure that the target packages:**
packages:**
- Haven't already been [requested](https://github.com/hlissner/doom-emacs/issues) or [PRed](https://github.com/hlissner/doom-emacs/pulls), - 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), - *Is not* in [our do-not-PR list](https://gist.github.com/hlissner/bb6365626d825aeaf5e857b1c03c9837),
@ -34,24 +29,16 @@ body:
attributes: attributes:
label: Why should Doom bump these packages early? label: Why should Doom bump these packages early?
description: | description: |
What has changed, upstream? Why do those changes warrant an early bump? 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.
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 - type: markdown
attributes: attributes:
value: | value: |
Please take a moment to ensure your bump request is **well-researched, 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.
descriptive, and specific**, otherwise, you risk it being significantly
delayed or automatically closed.
Emacs' complexity and extensibility produces many false positive or vague 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**.
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 If you don't think your request qualifies, please bring it up on [our Discord](https://doomemacs.org/discord) instead.
Discord](https://doomemacs.org/discord) instead.
:heart: **Thank you for taking the time to make this bump request!** :heart: **Thank you for taking the time to make this bump request!**

View file

@ -6,9 +6,7 @@ body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
> :warning: **Our issue tracker is for bug reports and feature requests, > :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.
> not configuration questions or requests for help.** Use [our
> Discord](https://doomemacs.org/discord) for those instead.
**Before you proceed, please ensure your request:** **Before you proceed, please ensure your request:**
@ -28,9 +26,7 @@ body:
attributes: attributes:
label: Briefly explain its use-case label: Briefly explain its use-case
description: | description: |
How would your requested feature be used? Can you demonstrate it with a 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.
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
@ -43,16 +39,10 @@ body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Please take a moment to ensure your feature request (and it's title) is 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.
**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 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**.
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 If you don't think your request qualifies, please bring it up on [our Discord](https://doomemacs.org/discord) instead.
Discord](https://doomemacs.org/discord) instead.
:heart: **Thank you for taking the time to make this feature request!** :heart: **Thank you for taking the time to make this feature request!**