Skip to content

Commit

Permalink
chore: add issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
suzuki-shunsuke committed Dec 9, 2024
1 parent 688bb06 commit 60a2c9a
Show file tree
Hide file tree
Showing 6 changed files with 229 additions and 61 deletions.
60 changes: 0 additions & 60 deletions .github/ISSUE_TEMPLATE/Bug_Report.md

This file was deleted.

85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: Bug Report
description: |
Please report the bug of aqua-registry.
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: package-name
attributes:
label: package name
description: |
e.g. `suzuki-shunsuke/github-comment`
validations:
required: false
- type: textarea
id: aqua-info
attributes:
label: aqua info
description: |
Please use the latest version.
Please run `aqua info` command and paste the result.
`aqua info` requires `aqua >= v2.10.0`.
If you use `aqua < v2.10.0`, please run `aqua -v` and write OS and CPU architecture instead.
If you checked multiple versions, please write the result too.
e.g. This issue occurs with aqua v2.5.0 too, but doesn't occur with aqua v2.4.0.
value: |
```console
$ aqua info
```
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.
aqua.yaml should be not partial but complete configuration.
Please remove unneeded configuration to reproduce the issue.
value: |
aqua.yaml
```yaml
```
Other related code such as local Registry
```
```
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
5 changes: 4 additions & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
blank_issues_enabled: true
blank_issues_enabled: false
contact_links:
- name: Issue of aqua
url: https://github.com/aquaproj/aqua/issues
about: Please report issues about aqua itself
- name: Contribution guide
url: https://aquaproj.github.io/docs/products/aqua-registry/contributing
about: This repository's contribution guide
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:
- no-fit-template
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
85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/support-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
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: package-name
attributes:
label: package name
description: |
e.g. `suzuki-shunsuke/github-comment`
validations:
required: false
- type: textarea
id: aqua-info
attributes:
label: aqua info
description: |
Please use the latest version.
Please run `aqua info` command and paste the result.
`aqua info` requires `aqua >= v2.10.0`.
If you use `aqua < v2.10.0`, please run `aqua -v` and write OS and CPU architecture instead.
If you checked multiple versions, please write the result too.
e.g. This issue occurs with aqua v2.5.0 too, but doesn't occur with aqua v2.4.0.
value: |
```console
$ aqua info
```
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.
aqua.yaml should be not partial but complete configuration.
Please remove unneeded configuration to reproduce the issue.
value: |
aqua.yaml
```yaml
```
Other related code such as local Registry
```
```
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 60a2c9a

Please sign in to comment.