Skip to content

Commit

Permalink
chore: add issue templates (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
suzuki-shunsuke authored Dec 23, 2024
1 parent 771047b commit 53a97cc
Show file tree
Hide file tree
Showing 6 changed files with 237 additions and 0 deletions.
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Bug Report
description: |
Please report a bug of tfmv.
If you're not sure if it's a bug or not, please use the template `Support Request` instead.
labels:
- bug
body:
- type: textarea
id: info
attributes:
label: Version and OS
description: |
Please use the latest version.
If you checked multiple versions, please write the result too.
e.g. This issue occurs using tfmv v0.2.1 and v0.2.2, but doesn't occur using v0.2.0.
value: |
```console
$ tfmv -v
```
OS:
validations:
required: true
- type: textarea
id: overview
attributes:
label: Overview
validations:
required: true
- type: textarea
id: how-to-reproduce
attributes:
label: How to reproduce
description: |
Please see [the guide](https://github.com/suzuki-shunsuke/oss-contribution-guide#write-good-how-to-reproduce) too.
Terraform Configuration should be not partial but complete configuration.
Please remove unnecessary configuration to reproduce the issue.
Please don't use private Modules and providers because they make it difficult to reproduce the issue.
value: |
Terraform Configuration:
```tf
```
Executed command and output:
```console
$
```
validations:
required: true
- type: textarea
id: expected-behaviour
attributes:
label: Expected behaviour
validations:
required: true
- type: textarea
id: actual-behaviour
attributes:
label: Actual behaviour
validations:
required: true
- type: textarea
id: note
attributes:
label: Note
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Feature Request
description: Feature Request
labels:
- enhancement
body:
- type: textarea
id: feature-overview
attributes:
label: Feature Overview
validations:
required: true
- type: textarea
id: why
attributes:
label: Why is the feature needed?
description: Please explain the problem you want to solve.
validations:
required: true
- type: textarea
id: example-code
attributes:
label: Example Code
description: |
Please explain the feature using code.
For example, if you want a new command line option, please explain the usage of the option.
value: |
```console
$
```
Expected result:
validations:
required: false
- type: textarea
id: note
attributes:
label: Note
validations:
required: false
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/general.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: General
description: Please use this template only when other templates don't meet your requirement
labels:
- general
body:
- type: textarea
id: what
attributes:
label: What
validations:
required: true
- type: textarea
id: why
attributes:
label: Why
description: Please explain the background and the reason of this issue
validations:
required: false
- type: textarea
id: note
attributes:
label: Note
description: Please write any additional information
validations:
required: false
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Question
description: |
Please use this template when you have any questions.
Please don't hesitate to ask any questions via Issues.
labels:
- question
body:
- type: textarea
id: question
attributes:
label: Question
description: |
Please explain your question in details.
If example code is useful to explain your question, please write it.
validations:
required: true
- type: textarea
id: background
attributes:
label: Background
description: Please explain the background and why you have the question
validations:
required: false
- type: textarea
id: note
attributes:
label: Note
description: Please write any additional information
validations:
required: false
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/support-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Support Request
description: |
Please use this template when you face any problem (not bug) and need our help.
If you're not sure if it's a bug or not, please use this template.
labels:
- support-request
body:
- type: textarea
id: info
attributes:
label: Version and OS
description: |
Please use the latest version.
If you checked multiple versions, please write the result too.
e.g. This issue occurs using tfmv v0.2.1 and v0.2.2, but doesn't occur using v0.2.0.
value: |
```console
$ tfmv -v
```
OS:
validations:
required: true
- type: textarea
id: overview
attributes:
label: Overview
validations:
required: true
- type: textarea
id: how-to-reproduce
attributes:
label: How to reproduce
description: |
Please see [the guide](https://github.com/suzuki-shunsuke/oss-contribution-guide#write-good-how-to-reproduce) too.
Terraform Configuration should be not partial but complete configuration.
Please remove unnecessary configuration to reproduce the issue.
Please don't use private Modules and providers because they make it difficult to reproduce the issue.
value: |
Terraform Configuration:
```tf
```
Executed command and output:
```console
$
```
validations:
required: true
- type: textarea
id: expected-behaviour
attributes:
label: Expected behaviour
validations:
required: true
- type: textarea
id: actual-behaviour
attributes:
label: Actual behaviour
validations:
required: true
- type: textarea
id: note
attributes:
label: Note
validations:
required: false

0 comments on commit 53a97cc

Please sign in to comment.