From 108f9877fecd199455a62816f7162f77020f5f7f Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Tue, 25 May 2021 14:19:24 -0400 Subject: [PATCH] Revise issue forms The dream: + Fewer "X doesn't work" / "X stopped working" issue + Fewer "Briefly summarize your issue here" issues --- .github/ISSUE_TEMPLATE/bug_report.yml | 31 ++++++++++++++-------- .github/ISSUE_TEMPLATE/feature_request.yml | 15 ++++++++--- 2 files changed, 32 insertions(+), 14 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 343a188fc3b..2bfac70c8ba 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,29 +1,30 @@ --- name: 📝 Bug Report description: Report a bug, error, or misbehavior -title: "Briefly summarize your issue here" +title: "{{{ Briefly summarize your issue here }}}" labels: ["1. bug", "needs-triage"] body: - type: markdown attributes: value: | - **Thank you for reporting an issue to our issue tracker!** - - Before you proceed, please consult our available resources and collect as much information about your issue as possible: - -
+ > :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. - type: checkboxes + label: Before you proceed... + description: | + 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. + + These guidelines will help you rule out these possibilities: attributes: options: - label: I have searched [the FAQ](https://doomemacs.org/docs/faq.org) and [the documentation](https://doomemacs.org/docs/getting_started.org) for solutions. required: true - label: I have searched [the issue tracker](https://github.com/hlissner/doom-emacs/issues) for similar issues (the closed issues too). required: true - - label: I have searched [the Discourse](https://discourse.doomemacs.org/docs) for any errors and solutions. - required: true + - label: I have searched [the Discourse](https://doomemacs.org/d/docs) for any errors and solutions. + required: true. - label: I can reproduce my issue on [the latest commit](https://github.com/hlissner/doom-emacs/commit) of Doom Emacs. required: true - - label: I have read [How to Debug Issues](https://discourse.doomemacs.org/how2debug) and found no solution. + - label: I have read [How to Debug Issues](https://doomemacs.org/d/how2debug) and found no solution. required: true - type: textarea attributes: @@ -36,9 +37,11 @@ body: label: What actually happened? description: | + Include screenshots/casts, if possible + + List *all* error messages and **[include backtraces for each of them](https://doomemacs.org/d/how2backtrace) + + 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) - + List *all* error messages and **[include backtraces for each of them](https://discourse.doomemacs.org/how2backtrace) + **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. placeholder: | When I do X, Z happened. Here is the backtrace: @@ -70,7 +73,7 @@ body: - type: textarea attributes: label: Steps to reproduce - description: How do we reproduce your issue? Please walk us through a minimal test case. + description: How do we reproduce your issue? Walk us through a minimal test case. placeholder: | 1. Open Emacs 2. `M-x doom/info` and be prompted to visit pastebin.com @@ -91,3 +94,9 @@ body: 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. + + **Thank you for taking the time to fill out a bug report!** diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 7bb7f45ea7e..180438528c7 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,19 +1,24 @@ --- name: 📝 Feature Request description: Propose a new idea or feature -title: "Briefly summarize your request here" +title: "{{{ Briefly summarize your request here }}}" labels: ["1. request", "needs-triage"] body: - type: checkboxes + label: Before you proceed... + description: | + We depend on you to ensure your issue hasn't already been addressed elsewhere, isn't resolvable by reading existing documentation, and isn't caused by personal configuration. + + These guidelines will help you rule out these possibilities: attributes: options: - - label: I have read the [contributing guide](https://discourse.doomemacs.org/how2contribute). + - label: I have read the [contributing guidelines](https://discourse.doomemacs.org/how2contribute). required: true - label: I have searched [the issue tracker](https://github.com/hlissner/doom-emacs/issues?q=label%3A%221.+request%22+) for similar requests. required: true - label: I have searched [the module list](https://doomemacs.org/docs/modules.org) in case my feature was already implemented. required: true - - label: I have confirmed that updating Doom won't fulfill my request. + - label: I have confirmed that my request remains unfulfilled on [the latest commit of Doom](https://github.com/hlissner/doom-emacs/commit). required: true - type: textarea attributes: @@ -38,3 +43,7 @@ body: 6. Ponder why your wife left you validations: required: true +- type: markdown + attributes: + value: | + **Thank you for taking the time to fill out a feature request!**