From a2b931e4c9cc9c2dc62f4ae6e07d70cd04fa29a2 Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Sun, 20 Feb 2022 03:36:35 +0100 Subject: [PATCH] dev: fix formatting in issue form templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 23 ++++++-------------- .github/ISSUE_TEMPLATE/bump_request.yml | 25 ++++++---------------- .github/ISSUE_TEMPLATE/feature_request.yml | 20 +++++------------ 3 files changed, 17 insertions(+), 51 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 941c8a9c3..664e1a32c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -68,8 +68,7 @@ body: 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! + > :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 @@ -84,29 +83,19 @@ body: attributes: label: System Information description: | - Provide a [pastebin.com](https://pastebin.com) link to 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: **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!** + > :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: | - 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. + 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. - 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**. + 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. + 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!** diff --git a/.github/ISSUE_TEMPLATE/bump_request.yml b/.github/ISSUE_TEMPLATE/bump_request.yml index b768ef7eb..4a102c687 100644 --- a/.github/ISSUE_TEMPLATE/bump_request.yml +++ b/.github/ISSUE_TEMPLATE/bump_request.yml @@ -6,18 +6,13 @@ body: - type: markdown attributes: value: | - 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. + 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 me know about these updates. ----- - **Before you submit this bump request, please ensure that the target - packages:** + **Before you submit this bump request, please ensure that the target packages:** - 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), @@ -34,24 +29,16 @@ body: attributes: label: Why should Doom bump these packages early? description: | - 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. + 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. + 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**. + 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. + 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!** diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 7af68bf2a..fdf32a358 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -6,9 +6,7 @@ body: - type: markdown attributes: value: | - > :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. + > :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, please ensure your request:** @@ -28,9 +26,7 @@ body: attributes: label: Briefly explain its use-case description: | - 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. + 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 @@ -43,16 +39,10 @@ body: - type: markdown attributes: value: | - 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. + 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**. + 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. + 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!**