Skip to content

Commit d1c00c5

Browse files
committed
dev: adopt issue forms
1 parent 138459f commit d1c00c5

File tree

3 files changed

+117
-0
lines changed

3 files changed

+117
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
name: 📝 Bug Report
3+
description: Report a bug, error, or misbehavior
4+
labels: ["type:bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
> :warning: **Our issue tracker is not for how-to or configuration questions.** Please post these on [the Doom Emacs Discourse](https://discourse.doomemacs.org) or its [Discord](https://doomemacs.org/discord) instead.
10+
11+
**Before you proceed, please ensure the following:**
12+
13+
- I've searched [our issue tracker](https://github.com/doomemacs/snippets/issues) for similar or duplicate issues.
14+
- I can reproduce the issue on the **latest** commit of doom-snippets.
15+
- If my issue contains an error message, I've included [a backtrace](https://discourse.doomemacs.org/t/what-is-a-backtrace-how-to-produce-them/85#how-to-produce-a-backtrace-3).
16+
- type: textarea
17+
attributes:
18+
label: What were you expecting?
19+
placeholder: X should look like Y
20+
validations:
21+
required: true
22+
- type: textarea
23+
attributes:
24+
label: What actually happened?
25+
description: |
26+
- Include screenshots/casts, if possible
27+
- List *all* error messages and **[include backtraces for each of them](https://doomemacs.org/d/how2backtrace)
28+
- Include any suspicious logs in the **[\*Messages\*](https://doomemacs.org/d/t/55) buffer.
29+
- If you include log dumps, please use [pastebin.com](https://pastebin.com)
30+
- **Use [code fences](https://docs.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks) for code, error messages, and backtraces.**
31+
- Avoid phrases like "X does not work" or "X stopped working" without explaining what "working" means.
32+
placeholder: |
33+
X looked like Z instead, then threw an error. Here is the backtrace:
34+
35+
```
36+
Debugger entered--Lisp error: (error "Beep Boop")
37+
error("Beep Boop")
38+
pp-eval-expression((error "Beep Boop"))
39+
\#<subr funcall-interactively>(pp-eval-expression (error "Beep Boop"))
40+
apply(#<subr funcall-interactively> (pp-eval-expression (error "Beep Boop")))
41+
funcall-interactively(pp-eval-expression (error "Beep Boop"))
42+
```
43+
validations:
44+
required: true
45+
- type: textarea
46+
attributes:
47+
label: Steps to reproduce
48+
description: How do we reproduce your issue? Walk us through a minimal test case.
49+
placeholder: |
50+
1. Type `trigger`
51+
2. Press TAB
52+
3. Yasnippet throws an error
53+
validations:
54+
required: true
55+
- type: input
56+
attributes:
57+
label: Operating system
58+
placeholder: NixOS 21.11
59+
validations:
60+
required: true
61+
- type: input
62+
attributes:
63+
label: Emacs version
64+
placeholder: Emacs 28.1 w/ native-comp
65+
validations:
66+
required: true
67+
- type: input
68+
attributes:
69+
label: Installed commit of doom-snippets
70+
placeholder: 2d031f723164
71+
validations:
72+
required: true
73+
- type: markdown
74+
attributes:
75+
value: |
76+
**Thank you for taking the time to fill out a bug report!**

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Project Do-not-PR list
4+
url: https://discourse.doomemacs.org/do-not-pr
5+
about: "A list of pull requests that will be rejected"
6+
- name: Visit our Discourse
7+
url: https://discourse.doomemacs.org
8+
about: "Our public discussion and support forum; includes guides, news, and resources"
9+
- name: Visit our Discord
10+
url: https://doomemacs.org/discord
11+
about: "A less formal space to chat, get to know the community, and get help quick"

.github/ISSUE_TEMPLATE/request.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: 📝 Feature request
3+
description: Request a change or new core feature
4+
labels: ["type:request", "needs-triage"]
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Describe your request
9+
placeholder: |
10+
I'd like snippets to fix my marriage.
11+
validations:
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Briefly explain its use-case
16+
description: |
17+
A happy marriage would make me a better programmer.
18+
placeholder: |
19+
1. Install Linux
20+
2. Install Emacs
21+
3. Install Doom
22+
4. Install Doom Eternal
23+
5. Speed run Doom Eternal
24+
6. Ponder why your wife left you
25+
validations:
26+
required: true
27+
- type: markdown
28+
attributes:
29+
value: |
30+
**Thank you for taking the time to fill out a feature request!**

0 commit comments

Comments
 (0)