diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 247844e6b..2285f116b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,32 +6,38 @@ title: "[BUG] " assignees: '' --- -**Describe the issue** -- 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). +**What did you expect to happen?** +... + + +**What actually happened?** +... + + +**Additional details:** +- Include a link to your private config +- Include screenshots/casts of your issue +- If you mention key sequences, include what commands they're bound to (use `SPC + h k KEY` or `C-h h k KEY` to inspect keys). +- Include any warnings or errors logged to \*Messages\* (use `M-x + view-echo-area-messages` to see it).
-Include a backtrace of the error.
+If an error message is involved include a backtrace of it.
 
 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
 
-**Steps to reproduce** +**Steps to reproduce:** 1. Select these example steps, 2. Delete them, 3. And replace them with precise steps to reproduce your issue. 4. Fill in "system information" below. -**System information** +**System information:**
 Place the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here.
 
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 7148f9f30..4ba9dc351 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,28 +1,22 @@ --- name: Feature request about: It'd be cool if Doom did/had/would... -labels: is:request +labels: is:new title: "[REQUEST] " assignees: '' --- **Describe the feature** -- What is your request? -- How is it helpful? -- How is it used? - If the feature involves new plugins, include links to them - 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) +- If the feature is implemented in another editor or Emacs distro, include: + - Screenshots or screencasts of it + - Links to its implementation + - Names of relevant commands (and not only the keybinds to invoke them) **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.
+Place the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here.
 
diff --git a/.github/ISSUE_TEMPLATE/how_to.md b/.github/ISSUE_TEMPLATE/how_to.md index 7336a60a5..ceedfaacf 100644 --- a/.github/ISSUE_TEMPLATE/how_to.md +++ b/.github/ISSUE_TEMPLATE/how_to.md @@ -6,14 +6,20 @@ title: "[HOWTO] " assignees: '' --- -**What I want to achieve** -- What are you trying to achieve? -- What have you tried? +**What are you trying to achieve?** +... + + +**What have you tried?** +... + + +**Additional information** - 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? + other editors/emacs distros) +- Do you have additional material or links to resources that could help clarify + what you are trying to do? **System information** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index eb8c16d71..6a69c8e63 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@ -> To ensure that this PR is processed as quickly as possible, please ensure the -> following steps have been taken: -> - [ ] This PR targets the develop branch and not master +> Please follow these steps before submitting your PR: +> +> - [ ] This PR targets the `develop` branch and not `master` > - [ ] If your PR is a work in progress, include [WIP] in its title > - [ ] Its commits' summaries are reasonably descriptive > - [ ] You've described what this PR addresses below