From ead07dea83e1bfef1f20ea9dfb7d3e0ce4d125a9 Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Wed, 10 Jul 2019 21:13:32 +0200 Subject: [PATCH] Fix issue/PR templates & add sponsor button Referenced in #1554, #1532, #1051 --- .github/FUNDING.yml | 3 ++ .github/ISSUE_TEMPLATE/bug_report.md | 39 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 22 +++++++++++ .github/ISSUE_TEMPLATE/howto.md | 26 +++++++++++++ {docs => .github}/ISSUE_TEMPLATE/question.md | 4 +- .github/PULL_REQUEST_TEMPLATE/bug_fix.md | 14 +++++++ .../PULL_REQUEST_TEMPLATE/documentation.md | 4 +- .github/PULL_REQUEST_TEMPLATE/feature.md | 14 +++++++ .../PULL_REQUEST_TEMPLATE/maintenance.md | 8 ++-- .../PULL_REQUEST_TEMPLATE/new_module.md | 6 +-- docs/ISSUE_TEMPLATE/bug_report.md | 39 ------------------- docs/ISSUE_TEMPLATE/feature_request.md | 24 ------------ docs/ISSUE_TEMPLATE/howto.md | 22 ----------- docs/PULL_REQUEST_TEMPLATE/bug_fix.md | 14 ------- 14 files changed, 128 insertions(+), 111 deletions(-) create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/howto.md rename {docs => .github}/ISSUE_TEMPLATE/question.md (58%) create mode 100644 .github/PULL_REQUEST_TEMPLATE/bug_fix.md rename {docs => .github}/PULL_REQUEST_TEMPLATE/documentation.md (70%) create mode 100644 .github/PULL_REQUEST_TEMPLATE/feature.md rename {docs => .github}/PULL_REQUEST_TEMPLATE/maintenance.md (58%) rename {docs => .github}/PULL_REQUEST_TEMPLATE/new_module.md (52%) delete mode 100644 docs/ISSUE_TEMPLATE/bug_report.md delete mode 100644 docs/ISSUE_TEMPLATE/feature_request.md delete mode 100644 docs/ISSUE_TEMPLATE/howto.md delete mode 100644 docs/PULL_REQUEST_TEMPLATE/bug_fix.md diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000000..28c703c0f73 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +# github: hlissner +liberapay: hlissner +custom: https://paypal.me/henriklissner \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000000..9fd980818ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,39 @@ +--- +name: "Bug report" +about: "Something went wrong, please fix it!" +title: "[BUG] " +labels: "is:bug", "status:pending-review" +--- + +**Describe the bug** +Begin with a short description of what the bug is. + +Some tips on writing a good bug report: +- Explain what you expected to see and what actually happened +- Include screenshots/casts of your issue, if possible +- Add a link to your private config, if available +- Expand on phrases like "it does not work" and clarify what commands are bound + on non-default keybinds. +- Check your \*Messages\* buffer for warnings or errors (`SPC h e` or `M-x + view-echo-area-messages`). +- Include a backtrace of the error, if possible. To acquire a backtrace, first + you must turn on `debug-on-error` then recreate the error. To do so, either: + - Turn on debug mode on the fly with `M-x toggle-debug-on-error`, + - Start Emacs with `emacs --debug-init` + - Or, if the error occurred while using `bin/doom`, use the `-d` or `--debug` + switches, or the `DEBUG` environment variable. +- If the backtrace is especially long, put it in + 
...
tags. + + +**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** +
+Include 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 new file mode 100644 index 00000000000..600b3d1c936 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,22 @@ +--- +name: "Feature Request" +about: "Make suggestions for improving Doom Emacs" +title: "[FEATURE] " +labels: "is:request", "status:pending-review" +--- + +**Describe the feature** +Summarize your suggestion or request. + +Include why it would be helpful and what type of user it would benefit most. + +If this feature is implemented in another editor or Emacs distro, please include +screenshots or screencasts of it. If possible, include the names of the relevant +commands and not just the keybinds to invoke them. Links to their implementation +in source code would tremendously speed up processing of this request. + + +**System information** +
+Include the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here.
+
diff --git a/.github/ISSUE_TEMPLATE/howto.md b/.github/ISSUE_TEMPLATE/howto.md new file mode 100644 index 00000000000..4434e9d601e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/howto.md @@ -0,0 +1,26 @@ +--- +name: "How do I..." +about: "How to get Doom to behave a certain way" +title: "[HOWTO] " +labels: "is:howto", "status:pending-review" +--- + +**What I want to achieve** +Summarize what you are trying to do. + +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 similar features in another editor or elsewhere, +- Additional material or links to resources that could help clarify what you are + trying to do. +- A link to your private config, if it is available publicly. +- The names of commands available in other Emacs distros (rather than just the + keybinds that invoke them). + + +**System information** +
+Include the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here.
+
diff --git a/docs/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md similarity index 58% rename from docs/ISSUE_TEMPLATE/question.md rename to .github/ISSUE_TEMPLATE/question.md index 089eab8de42..1d351cf8aa5 100644 --- a/docs/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -5,6 +5,4 @@ title: "[QUESTION] " labels: "is:question", "status:pending-review" --- -Start with a one-or-two sentence summary of your question. - -Then follow with an expanded explanation... +What would you like to know? diff --git a/.github/PULL_REQUEST_TEMPLATE/bug_fix.md b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md new file mode 100644 index 00000000000..841a12f2ed6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md @@ -0,0 +1,14 @@ +--- +name: "Bug Fix" +about: "For fixing bugs originating from Doom" +title: "[BUGFIX] " +labels: "is:bug", "status:pending-review" +--- + +> This category is for bug fixes. + +Thank you for contributing to Doom! + +Before you submit this PR, please make sure it is targeted at the `develop` +branch and not `master`. Include links to relevant issues or, if the issue isn't +self-evident, describe the problem that is being fixed. diff --git a/docs/PULL_REQUEST_TEMPLATE/documentation.md b/.github/PULL_REQUEST_TEMPLATE/documentation.md similarity index 70% rename from docs/PULL_REQUEST_TEMPLATE/documentation.md rename to .github/PULL_REQUEST_TEMPLATE/documentation.md index cd3d32a8697..32c7bcb8b39 100644 --- a/docs/PULL_REQUEST_TEMPLATE/documentation.md +++ b/.github/PULL_REQUEST_TEMPLATE/documentation.md @@ -9,5 +9,5 @@ labels: "re:docs", "status:pending-review" Thank you for contributing to Doom! -Before you submit this PR, please make sure it is targeted at `develop` and not -`master`. +Before you submit this PR, please make sure it is targeted at the `develop` +branch and not `master`. diff --git a/.github/PULL_REQUEST_TEMPLATE/feature.md b/.github/PULL_REQUEST_TEMPLATE/feature.md new file mode 100644 index 00000000000..2480b828f41 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/feature.md @@ -0,0 +1,14 @@ +--- +name: "New Feature" +about: "For new bells 'n whistles for old modules" +title: "[FEATURE] " +labels: "is:request", "status:pending-review" +--- + +> This category is for PRs that add features to pre-existing modules or Doom +> core. + +Thank you for contributing to Doom! + +Before you submit this PR, please make sure it is targeted at the `develop` +branch and not `master`. diff --git a/docs/PULL_REQUEST_TEMPLATE/maintenance.md b/.github/PULL_REQUEST_TEMPLATE/maintenance.md similarity index 58% rename from docs/PULL_REQUEST_TEMPLATE/maintenance.md rename to .github/PULL_REQUEST_TEMPLATE/maintenance.md index cbe1f408923..178fd9cbb6c 100644 --- a/docs/PULL_REQUEST_TEMPLATE/maintenance.md +++ b/.github/PULL_REQUEST_TEMPLATE/maintenance.md @@ -1,7 +1,7 @@ --- name: "Maintenance" about: "Minor corrections, refactors or bugfixes for changes upstream" -title: "[REFACTOR] " +title: "[MAINTAIN] " labels: "is:refactor", "status:pending-review" --- @@ -10,6 +10,6 @@ labels: "is:refactor", "status:pending-review" Thank you for contributing to Doom! -Before you submit this PR, please make sure it is targeted at `develop` and not -`master`. Include links to relevant issues or, if the issue isn't self-evident, -describe the problem that is being fixed. +Before you submit this PR, please make sure it is targeted at the `develop` +branch and not `master`. Include links to relevant issues or, if the issue isn't +self-evident, describe the problem that is being fixed. diff --git a/docs/PULL_REQUEST_TEMPLATE/new_module.md b/.github/PULL_REQUEST_TEMPLATE/new_module.md similarity index 52% rename from docs/PULL_REQUEST_TEMPLATE/new_module.md rename to .github/PULL_REQUEST_TEMPLATE/new_module.md index 0f37bd53f38..6649ae95b69 100644 --- a/docs/PULL_REQUEST_TEMPLATE/new_module.md +++ b/.github/PULL_REQUEST_TEMPLATE/new_module.md @@ -2,12 +2,12 @@ name: "New Module" about: "For brand spankin' new modules" title: "[MODULE] " -labels: "is:request", "re:modules", "status:pending-review" +labels: "is:request", "re:module", "status:pending-review" --- > This category is for PRs that add new modules. Thank you for contributing to Doom! -Before you submit this PR, please make sure it is targeted at `develop` and not -`master`. +Before you submit this PR, please make sure it is targeted at the `develop` +branch and not `master`. diff --git a/docs/ISSUE_TEMPLATE/bug_report.md b/docs/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 70967378bbc..00000000000 --- a/docs/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: "Bug report" -about: "Something went wrong, please fix it!" -title: "[BUG] " -labels: "is:bug", "status:pending-review" ---- - -**Describe the bug** -Begin with a short description of what the bug is. - -If possible, include screen{shots,casts} and a link to your private config, if -it is available publicly. - -
-
-If you received an error, paste the backtrace here.
-
-To acquire a backtrace either:
-
-1. Turn on debug mode with `M-x toggle-debug-on-error` or
-2. Start Emacs with `emacs --debug-init`
-3. Or, if the error occurred while using `bin/doom`, use the `-d` or `--debug`
-   switch.
-
-Then recreate the error and Emacs should produce a backtrace.
-
-
- -**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. - -**Expected behavior** -Describe what you expected to happen. - -**System information** -Paste the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here. diff --git a/docs/ISSUE_TEMPLATE/feature_request.md b/docs/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bb25c4ab170..00000000000 --- a/docs/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: "Feature Request" -about: "Make suggestions for improving Doom Emacs" -title: "[FEATURE] " -labels: "is:request", "status:pending-review" ---- - -**Describe the feature** -Start with a one-or-two sentence summary of your suggestion or request. - -Then follow with an expanded explanation. A few suggestions of what you could -include here: - -+ Why you think it would be helpful, -+ Screenshots/casts of this feature in another editor or elsewhere, -+ Links to any relevant packages. - -**Relevant resources** -Include links to relevant plugins, projects and/or websites. - -**System information** -Include the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` here. It's -possible that the feature you're requesting is already in Doom, but you haven't -enabled it. diff --git a/docs/ISSUE_TEMPLATE/howto.md b/docs/ISSUE_TEMPLATE/howto.md deleted file mode 100644 index 447e26c06ad..00000000000 --- a/docs/ISSUE_TEMPLATE/howto.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: "How do I..." -about: "How to get Doom to behave a certain way" -title: "[HOWTO] " -labels: "is:howto", "status:pending-review" ---- - -**What I want to achieve** -Start with a one-or-two sentence summary of what you are trying to do. - -Then follow with an expanded explanation. A few suggestions of what you could -include: - -+ Code or steps you've tried that did not yield the results you wanted, -+ Screenshots/casts of similar features in another editor or elsewhere, -+ Additional material or links to resources that could help clarify what you are - trying to do. -+ A link to your private config, if it is available publicly. - -**System information** -If it is pertinent to your goal, include the output of `M-x doom/info` or -`~/.emacs.d/bin/doom info` here. diff --git a/docs/PULL_REQUEST_TEMPLATE/bug_fix.md b/docs/PULL_REQUEST_TEMPLATE/bug_fix.md deleted file mode 100644 index 018bcf4e84a..00000000000 --- a/docs/PULL_REQUEST_TEMPLATE/bug_fix.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: "Bug Fix" -about: "For fixing bugs originating from Doom" -title: "[BUGFIX] " -labels: "is:bug", "status:pending-review" ---- - -> This category is for bug fixes. - -Thank you for contributing to Doom! - -Before you submit this PR, please make sure it is targeted at `develop` and not -`master`. Include links to relevant issues or, if the issue isn't self-evident, -describe the problem that is being fixed.