From 60a2c9a6380fa837c725fc0e63ddee5d6c6c75dd Mon Sep 17 00:00:00 2001 From: Shunsuke Suzuki Date: Mon, 9 Dec 2024 09:24:38 +0900 Subject: [PATCH] chore: add issue templates --- .github/ISSUE_TEMPLATE/Bug_Report.md | 60 --------------- .github/ISSUE_TEMPLATE/bug-report.yml | 85 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +- .github/ISSUE_TEMPLATE/general.yml | 25 +++++++ .github/ISSUE_TEMPLATE/question.yml | 30 ++++++++ .github/ISSUE_TEMPLATE/support-request.yml | 85 ++++++++++++++++++++++ 6 files changed, 229 insertions(+), 61 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/Bug_Report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/general.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml create mode 100644 .github/ISSUE_TEMPLATE/support-request.yml diff --git a/.github/ISSUE_TEMPLATE/Bug_Report.md b/.github/ISSUE_TEMPLATE/Bug_Report.md deleted file mode 100644 index 060c90a5e8f..00000000000 --- a/.github/ISSUE_TEMPLATE/Bug_Report.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -name: Bug Report -about: If something isn't working as expected. ---- - -## package name - -e.g. `suzuki-shunsuke/github-comment` - -- - -## aqua version - -Please use the latest version. - -```console -aqua -v - -``` - -## Environment - -- OS (Windows, Linux, macOS, etc): -- CPU Architecture (amd64, arm64, etc): - -## Overview - -## How to reproduce - -- aqua.yaml -- executed command and output - -> aqua.yaml should be not partial but complete configuration. -> Please remove unneeded configuration to reproduce the issue. - -```yaml -# aqua.yaml -``` - -```console - -``` - -## Debug Output - -Please set the environment variable `AQUA_LOG_LEVEL=debug` and run aqua and tell us the debug output. - -```console - -``` - -## Expected Behaviour - -## Actual Behaviour - -## Important Factoids - -## References - -- diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000000..38370fad02b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 136960065b0..b49efc6382c 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/general.yml b/.github/ISSUE_TEMPLATE/general.yml new file mode 100644 index 00000000000..9dde52b9028 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 00000000000..f6731514289 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/support-request.yml b/.github/ISSUE_TEMPLATE/support-request.yml new file mode 100644 index 00000000000..b95c95de5c0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/support-request.yml @@ -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