Add more issue forms and rewrite PR template
This commit is contained in:
parent
ea9753a5f2
commit
5e8648e6c1
9 changed files with 106 additions and 96 deletions
24
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
24
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
@ -1,32 +1,30 @@
|
|||
---
|
||||
name: 📝 Bug Report
|
||||
description: Report a bug, error, or misbehavior
|
||||
labels: ["1. bug", "2. status:unread"]
|
||||
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!**
|
||||
|
||||
> **Tip:** If you are seeking support or usage advice, head over to [our Discord](https://doomemacs.org/discord) or [our Discourse](https://discourse.doomemacs.org) instead.
|
||||
|
||||
Before you proceed, please consult our available resources and collect as much information about your issue as possible:
|
||||
|
||||
-----
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
options:
|
||||
# - label: I have read the [contributing guide](https://discourse.doomemacs.org/how2contribute).
|
||||
# required: true
|
||||
- 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 can reproduce my issue on [the latest commit](https://github.com/hlissner/doom-emacs/commit) of Doom Emacs.
|
||||
required: true
|
||||
# - label: I have searched [the Discourse](https://discourse.doomemacs.org/docs) for solutions.
|
||||
# required: true
|
||||
# - label: I have read [How to Debug Issues](https://discourse.doomemacs.org/how2debug) and found no solution.
|
||||
# required: true
|
||||
- label: I have searched [the Discourse](https://discourse.doomemacs.org/docs) for solutions.
|
||||
required: true
|
||||
- label: I have read [How to Debug Issues](https://discourse.doomemacs.org/how2debug) and found no solution.
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: What did you expect to happen?
|
||||
|
@ -37,9 +35,9 @@ body:
|
|||
attributes:
|
||||
label: What actually happened?
|
||||
description: |
|
||||
Include screenshots/casts, logs, and [backtraces for errors](https://discourse.doomemacs.org/how2backtrace), if possible.
|
||||
|
||||
**HINT: Remember to use [code fences](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) for code, log output, and backtraces.**
|
||||
+ Include screenshots/casts, if possible
|
||||
+ If you include log dumps, please use [pastebin.com](https://pastebin.com)
|
||||
+ If you're reporting an error, [include a backtrace](https://discourse.doomemacs.org/how2backtrace) in [code fences](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks)**
|
||||
placeholder: |
|
||||
When I do X, Z happened. Here is the backtrace:
|
||||
|
||||
|
@ -51,6 +49,8 @@ body:
|
|||
apply(#<subr funcall-interactively> (pp-eval-expression (error "Beep Boop")))
|
||||
funcall-interactively(pp-eval-expression (error "Beep Boop"))
|
||||
```
|
||||
|
||||
And here is the log: https://pastebin.com/fakeurl
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
|
|
39
.github/ISSUE_TEMPLATE/bump_request.yml
vendored
Normal file
39
.github/ISSUE_TEMPLATE/bump_request.yml
vendored
Normal file
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
name: 📝 Bump Package
|
||||
description: Request a pinned package be updated
|
||||
title: "[BUMP] package1, package2, ..."
|
||||
labels: ["1. update", "needs-triage"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Doom pins its packages to certain commits to avoid breaking updates and to help its maintainer keep up with changes. These pins are updated (bumped) frequently, usually every other week, but some may warrant an early bump, due to critical bug fixes or to adapt to external events.
|
||||
|
||||
Use this form to let us know about these packages. Alternatively, [file a bump PR](https://discourse.doomemacs.org/how2bump).
|
||||
|
||||
-----
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
options:
|
||||
- label: There are no other bump requests for this package [on the issue tracker](https://github.com/hlissner/doom-emacs/pulls?q=is%3Apr+is%3Aopen+label%3A%221.+update%29%22+).
|
||||
required: true
|
||||
- label: The package(s) I want bumped are not in [the do-not-PR list](https://discourse.doomemacs.org/do-not-pr) list.
|
||||
required: true
|
||||
- label: These packages still need to be bumped on the [latest commit of Doom](https://github.com/hlissner/doom-emacs/commit).
|
||||
required: true
|
||||
- label: I've tested the new versions of these packages myself and can report on its issues (if any).
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: What package(s) should be bumped?
|
||||
placeholder: |
|
||||
lsp-mode, lsp-python-ms, lsp-pyright, ...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Why should Doom bump these packages early?
|
||||
description: |
|
||||
Briefly describe what has changed, and why they 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.
|
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
|
@ -2,7 +2,7 @@ blank_issues_enabled: false
|
|||
contact_links:
|
||||
- name: Official Documentation
|
||||
url: https://doomemacs.org/docs/index.org
|
||||
about: "Our in-repo manual documents. Also available from within Doom: `M-x doom/help`"
|
||||
about: "Walks you through how to use, abuse, or confuse Doom Emacs. Also available from within Doom: `M-x doom/help`"
|
||||
- name: Visit our Discourse (work in progress)
|
||||
url: https://discourse.doomemacs.org
|
||||
about: "A repository of official learning resources and discussion forum for Emacs and Doom"
|
||||
|
|
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: It'd be cool if Doom did/had/would...
|
||||
---
|
||||
|
||||
**Describe the feature**
|
||||
- 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
|
||||
- Links to its implementation
|
||||
- Names of relevant commands (and not only the keybinds to invoke them)
|
||||
|
||||
|
||||
**System information**
|
||||
<!--
|
||||
Post the output of `M-x doom/info` or `~/.emacs.d/bin/doom info` to
|
||||
pastebin.com and paste the link here.
|
||||
<!--
|
38
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
38
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
name: 📝 Feature Request
|
||||
description: Propose a new idea or feature
|
||||
title: "Briefly summarize your request here"
|
||||
labels: ["1. request", "needs-triage"]
|
||||
body:
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
options:
|
||||
- label: I have read the [contributing guide](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
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Describe your request
|
||||
placeholder: |
|
||||
I'd like Doom to incorporate the game, Doom Eternal, into Doom Emacs, [found here](https://store.steampowered.com/app/379720/DOOM/).
|
||||
|
||||
It replaces `M-x doctor` with a superior alternative: a distraction from your personal problems.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Briefly explain its use-case
|
||||
description: |
|
||||
A screencast is ideal, but a list of steps and effects showing off how it would work is acceptable.
|
||||
placeholder: |
|
||||
1. Install Linux
|
||||
2. Install Emacs
|
||||
3. Install Doom
|
||||
4. Install Doom Eternal
|
||||
5. Speed run Doom Eternal
|
||||
6. Ponder why your wife left you
|
||||
validations:
|
||||
required: true
|
15
.github/ISSUE_TEMPLATE/how_to.md
vendored
15
.github/ISSUE_TEMPLATE/how_to.md
vendored
|
@ -1,15 +0,0 @@
|
|||
---
|
||||
name: How do I...
|
||||
about: How to get Doom/Emacs to behave a certain way
|
||||
labels: is:invalid
|
||||
---
|
||||
|
||||
Please do not post usage/configuration questions on Doom's issue tracker.
|
||||
|
||||
They will be deleted without warning.
|
||||
|
||||
Visit our Discord server to ask how-to and workflow questions:
|
||||
https://doomemacs.org/discord
|
||||
|
||||
Or visit our FAQ:
|
||||
https://doomemacs.org/docs/faq.org
|
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
16
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
@ -0,0 +1,16 @@
|
|||
<!--
|
||||
Thank you for contributing to Doom Emacs! <3
|
||||
|
||||
To ensure your PR isn't refused, please ensure it meets the criteria:
|
||||
-->
|
||||
|
||||
> - [ ] I've targeted the develop branch
|
||||
> - [ ] I've searched for similar pull requests and found nothing
|
||||
> - [ ] This change is NOT in Doom's do-not-PR list: https://doomemacs.org/d/do-not-pr
|
||||
> - [ ] If I've bumped any packages, I've done so according to https://doomemacs.org/d/how2bump
|
||||
> - [ ] I've linked any relevant issues and PRs below
|
||||
> - [ ] All my commit messages are descriptive and distinct
|
||||
|
||||
Fixes #0000 <!-- remove if not applicable -->
|
||||
|
||||
{{{ Summarize what you have changed. Include motivation and relevant context. }}}
|
31
.github/PULL_REQUEST_TEMPLATE/bump.md
vendored
31
.github/PULL_REQUEST_TEMPLATE/bump.md
vendored
|
@ -1,31 +0,0 @@
|
|||
---
|
||||
name: Bump a package
|
||||
about: Update a pinned package to a new commit
|
||||
labels: is:update re:packages
|
||||
---
|
||||
> You're about to request a package be bumped to a newer commit.
|
||||
>
|
||||
> 1. Please make sure this PR targets the `develop` branch and not `master`.
|
||||
> 2. Describe why these bumps are necessary below
|
||||
> 3. Please conform your commit messages to one of the following formats:
|
||||
>
|
||||
> Bump to username/repo@a1b2c3d
|
||||
>
|
||||
> From username/repo@z9y8x7w
|
||||
>
|
||||
> OR, if multiple packages are bumped in one commit:
|
||||
>
|
||||
> Bump :tools lsp
|
||||
>
|
||||
> emacs-lsp/lsp-mode@91e37a6 -> emacs-lsp/lsp-mode@c8188ef
|
||||
> emacs-lsp/lsp-ui@cf6906c -> emacs-lsp/lsp-ui@582e153
|
||||
>
|
||||
> Commit hashes should be limited to 7 characters. Include additional
|
||||
> commentary after the list of commit changes.
|
||||
>
|
||||
> 4. You've included links to relevant issues, if any
|
||||
> 5. You've deleted this template
|
||||
>
|
||||
> Thank you for contributing to Doom Emacs! <3
|
||||
|
||||
Explain why this bump is necessary here...
|
17
.github/PULL_REQUEST_TEMPLATE/general.md
vendored
17
.github/PULL_REQUEST_TEMPLATE/general.md
vendored
|
@ -1,17 +0,0 @@
|
|||
---
|
||||
name: General Contribution
|
||||
about: A general code or documentation PR
|
||||
---
|
||||
> Please follow these steps before submitting your PR:
|
||||
>
|
||||
> - [ ] Make sure yours is the only PR for your issue!
|
||||
> - [ ] 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
|
||||
> - [ ] You've included links to relevant issues, if any
|
||||
> - [ ] You've deleted this template
|
||||
>
|
||||
> Thank you for contributing to Doom Emacs! <3
|
||||
|
||||
Your description here...
|
Loading…
Reference in a new issue