Skip to content

Commit c02d8bc

Browse files
docs: add issue templates (#13)
1 parent 6f47e24 commit c02d8bc

File tree

4 files changed

+128
-0
lines changed

4 files changed

+128
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Bug Report
2+
description: If something isn't working as expected.
3+
labels:
4+
- bug
5+
body:
6+
- type: textarea
7+
id: overview
8+
attributes:
9+
label: Overview
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: how-to-reproduce
14+
attributes:
15+
label: How to reproduce
16+
description: |
17+
Please see [the guide](https://github.com/suzuki-shunsuke/oss-contribution-guide#write-good-how-to-reproduce) too.
18+
devcontainer.json should be not partial but complete configuration.
19+
Please remove unneeded configuration to reproduce the issue.
20+
value: |
21+
.devcontainer/devcontainer.json
22+
23+
```json
24+
25+
```
26+
27+
Other related code
28+
29+
```
30+
31+
```
32+
33+
Executed command and output
34+
35+
```console
36+
$
37+
```
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: expected-behaviour
42+
attributes:
43+
label: Expected behaviour
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: actual-behaviour
48+
attributes:
49+
label: Actual behaviour
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: note
54+
attributes:
55+
label: Note
56+
description: Additional information about the discussion.
57+
validations:
58+
required: false

.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: Discussions
4+
url: https://github.com/orgs/aquaproj/discussions
5+
about: Please create a discussion instead of issue
6+
- name: Slack
7+
url: https://gophers.slack.com/archives/C04RALTG29K
8+
about: Please ask questions freely
9+
- name: Discord
10+
url: https://discord.com/channels/1141777454164365382/1162444533959757955
11+
about: Please ask questions freely
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Feature Request
2+
description: If you want to add a feature.
3+
labels:
4+
- enhancement
5+
body:
6+
- type: textarea
7+
id: feature-overview
8+
attributes:
9+
label: Feature Overview
10+
validations:
11+
required: true
12+
- type: textarea
13+
id: why
14+
attributes:
15+
label: Why is the feature needed?
16+
description: Please explain the problem you want to solve.
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: workaround
22+
attributes:
23+
label: Workaround
24+
description: |
25+
If you have any workaround, please explain it and why the workaround isn't enough.
26+
27+
- type: textarea
28+
id: example-code
29+
attributes:
30+
label: Example Code
31+
description: |
32+
Please explain the feature with code. For example, if you want a new option, please explain the usage of the option.
33+
value: |
34+
```console
35+
$
36+
```
37+
38+
Configuration
39+
40+
```json
41+
42+
```
43+
validations:
44+
required: false
45+
- type: textarea
46+
id: note
47+
attributes:
48+
label: Note
49+
validations:
50+
required: false

.github/ISSUE_TEMPLATE/general.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name: General
2+
description: Please use this template only when other templates don't meet your requirement
3+
body:
4+
- type: textarea
5+
id: free-text
6+
attributes:
7+
label: Free Text
8+
validations:
9+
required: true

0 commit comments

Comments
 (0)