From ae80f1f67d1abf4e30b09184465231767082ad36 Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Thu, 28 Nov 2019 15:32:50 -0500 Subject: [PATCH] Simplify github issue templates; correct labels If they're too long, people won't read them. If they're too short, people won't know what to do. If there are too many of them, people can't decide which to use. Removed the question template because it's redundant with "open a blank issue". --- .github/ISSUE_TEMPLATE/bug_report.md | 30 +++++++++-------------- .github/ISSUE_TEMPLATE/feature_request.md | 18 +++++++------- .github/ISSUE_TEMPLATE/how_to.md | 20 ++++++--------- .github/ISSUE_TEMPLATE/question.md | 9 ------- 4 files changed, 29 insertions(+), 48 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 1a70d0fd7..247844e6b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,32 +1,26 @@ --- name: Bug report -about: Something went wrong, please fix it! +about: Doom might be misbehaving labels: is:bug title: "[BUG] " assignees: '' --- **Describe the issue** -Start with a brief 1 or 2 sentence summary of issue. - -Then follow with a longer explanation, if necessary. Here are some suggestions -on what to include: -- What you expected vs what actually happened -- Screenshots/casts of your issue -- A link to your private config -- Labels for any keys you reference (use `SPC h k` to inspect a key) -- Any warnings or errors logged to \*Messages\* (`SPC h e` or `M-x - view-echo-area-messages`). +- What did you expect to happen? +- What actually happened? +- Do you have screenshots/casts of your issue? +- What commands are bound to any keys you've referenced? (use `SPC h k` to + inspect keys) +- Can you include a link to your private config? +- Were any warnings or errors logged to \*Messages\* (`SPC h e` or `M-x + view-echo-area-messages` will open it). 
-If available, please a backtrace of the error here.
+Include a backtrace of the error.
 
-To acquire a backtrace, enable `debug-on-error` then recreate the error. Here
-are ways to enable `debug-on-error`:
-- `M-x toggle-debug-on-error`,
-- Start Emacs with `emacs --debug-init`
-- If the error occurred while using `bin/doom`, use the `-d`/`--debug`
-- switches or the `DEBUG` environment variable.
+How to acquire a backtrace:
+https://github.com/hlissner/doom-emacs/blob/develop/docs/getting_started.org#how-to-extract-a-backtrace-from-an-error
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index b3b4514c6..7148f9f30 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,22 +1,19 @@ --- name: Feature request -about: Make suggestions for improving Doom Emacs +about: It'd be cool if Doom did/had/would... labels: is:request title: "[REQUEST] " assignees: '' --- **Describe the feature** -Start with a brief 1 or 2 sentence summary of feature. - -Then follow up with an extended explanation, if necessary. Here are some -suggestions on what to include: +- What is your request? - How is it helpful? -- How is the feature used? +- How is it used? - If the feature involves new plugins, include links to them -- iF the feature involves replacement of current functionality, describe how the - new functionality is better. -- If the feature is implemented in another editor Emacs distro: +- If the feature involves replacement of current functionality, how the new + functionality is better? +- If the feature is implemented in another editor or Emacs distro: - Include screenshots or screencasts of it - Include links to its implementation - Include names of commands (and not just the keybinds to invoke them) @@ -25,4 +22,7 @@ suggestions on what to include: **System information** 
 Include the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here.
+
+It's possible Doom already has the feature you're requesting. This will tell me
+why you aren't seeing it.
diff --git a/.github/ISSUE_TEMPLATE/how_to.md b/.github/ISSUE_TEMPLATE/how_to.md index 033e31a80..7336a60a5 100644 --- a/.github/ISSUE_TEMPLATE/how_to.md +++ b/.github/ISSUE_TEMPLATE/how_to.md @@ -1,23 +1,19 @@ --- name: How do I... about: How to get Doom/Emacs to behave a certain way -labels: is:howto, status:pending-review +labels: is:question title: "[HOWTO] " assignees: '' --- **What I want to achieve** -Start with a brief 1 or 2 sentence summary of what you're trying to achieve. - -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 a proposed workflow in another editor or Emacs distro, -- Additional material or links to resources that could help clarify what you are - trying to do. -- A link to your private config, if available. -- The names of commands available in other Emacs distros (rather than just the - keybinds that invoke them). +- What are you trying to achieve? +- What have you tried? +- Do you have screenshots/casts of this workflow in another editor or Emacs + distro? (If possible, include names of specific commands or functions from + other editors/kemacs distros) +- Do you have extra material or links to resources that could help clarify what + you are trying to do? **System information** diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 0853f526f..000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -name: Question -about: A question about the project or maintainer -labels: is:question, status:pending-review -title: "[QUESTION] " -assignees: '' ---- - -What would you like to know?