Skip to content

Commit 70ecf23

Browse files
authored
chore: update issue templates (#1357)
* chore: update bug template * chore: add basic idea template * chore: use existing `feature` label for ideas * chore: fix typos
1 parent 8b08fc0 commit 70ecf23

File tree

3 files changed

+130
-21
lines changed

3 files changed

+130
-21
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
name: Bug Report
2+
description: File a bug report.
3+
title: '[Bug]: '
4+
labels: ['bug']
5+
assignees:
6+
- antongolub
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this bug report!
12+
13+
- type: textarea
14+
id: what-happened
15+
attributes:
16+
label: What happened?
17+
placeholder: Tell us what you see.
18+
value: 'A bug happened!'
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: what-expected
24+
attributes:
25+
label: How it should work?
26+
description: Also tell us, what did you expect to happen?
27+
value: "Here's how it should work..."
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: steps-to-reproduce
33+
attributes:
34+
label: How to reproduce the bug?
35+
description: Show an example.
36+
value: 'Step-by-step instructions to reproduce the behavior. Code snippet, gist or issue-demo repository are helpful'
37+
validations:
38+
required: true
39+
40+
- type: input
41+
id: version
42+
attributes:
43+
label: Version
44+
description: What zx version are you running?
45+
placeholder: e.g. 0.0.0
46+
validations:
47+
required: true
48+
49+
- type: dropdown
50+
id: os
51+
attributes:
52+
label: What's OS kind?
53+
multiple: true
54+
options:
55+
- Linux
56+
- Mac
57+
- Windows
58+
59+
- type: dropdown
60+
id: runtime
61+
attributes:
62+
label: What JS runtime is used?
63+
multiple: true
64+
options:
65+
- Node.js
66+
- Deno
67+
- Bun
68+
- GraalVM
69+
70+
- type: input
71+
id: runtime-version
72+
attributes:
73+
label: Runtime Version
74+
description: What JS runtime version are you running?
75+
placeholder: e.g. 0.0.0
76+
77+
- type: textarea
78+
id: logs
79+
attributes:
80+
label: Error stack / relevant log output
81+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
82+
render: shell
83+
84+
- type: checkboxes
85+
id: terms
86+
attributes:
87+
label: Code of Conduct
88+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/google/zx?tab=coc-ov-file).
89+
options:
90+
- label: I agree to follow this project's Code of Conduct
91+
required: true

.github/ISSUE_TEMPLATE/idea.yaml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Feature Request
2+
description: Idea, feature request or proposal.
3+
title: '[Idea]: '
4+
labels: ['feature']
5+
assignees:
6+
- antonmedv
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thanks for sharing your vision!
13+
14+
- type: textarea
15+
id: idea
16+
attributes:
17+
label: What's your idea?
18+
placeholder: Tell us what you'd like to add or improve.
19+
value: 'A new shiny feature!'
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: why
25+
attributes:
26+
label: Why is that needed? How it may be useful?
27+
placeholder: What problem does it solve?.
28+
value: 'It will make something easier because...'
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: demo
34+
attributes:
35+
label: Maybe you have a demo or example?
36+
value: 'API sketch, code snippet'
37+
render: ts
38+
validations:
39+
required: false

0 commit comments

Comments
 (0)