From f9c11b5c36be9458cb18e00fcd5851957f51856f Mon Sep 17 00:00:00 2001 From: Mathew Wicks Date: Wed, 12 Jan 2022 20:15:58 +1100 Subject: [PATCH] chore: use new GitHub issue templates Signed-off-by: Mathew Wicks --- .github/ISSUE_TEMPLATE/01_bug_report.md | 61 -------------- .github/ISSUE_TEMPLATE/01_bug_report.yml | 82 +++++++++++++++++++ .github/ISSUE_TEMPLATE/02_feature_request.md | 18 ---- .github/ISSUE_TEMPLATE/02_feature_request.yml | 40 +++++++++ .github/ISSUE_TEMPLATE/03_docs_issue.yml | 29 +++++++ .github/ISSUE_TEMPLATE/03_question.md | 13 --- .github/ISSUE_TEMPLATE/04_documentation.md | 13 --- .github/ISSUE_TEMPLATE/04_question.yml | 24 ++++++ .github/ISSUE_TEMPLATE/config.yaml | 1 + 9 files changed, 176 insertions(+), 105 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/01_bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/01_bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/02_feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/02_feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/03_docs_issue.yml delete mode 100644 .github/ISSUE_TEMPLATE/03_question.md delete mode 100644 .github/ISSUE_TEMPLATE/04_documentation.md create mode 100644 .github/ISSUE_TEMPLATE/04_question.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yaml diff --git a/.github/ISSUE_TEMPLATE/01_bug_report.md b/.github/ISSUE_TEMPLATE/01_bug_report.md deleted file mode 100644 index 3d3efe45..00000000 --- a/.github/ISSUE_TEMPLATE/01_bug_report.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -name: Bug Report -about: Report something not working properly! -title: '' -labels: 'bug' -assignees: '' ---- - - - -## What is the bug? - -The bug is... - - -## What version of the chart? - -I am using version `X.X.X` of this chart. - - -## What version of Kubernetes? - -```console - -# output of `kubectl version` command -Client Version: ... -Server Version: ... - -``` - - -## What version of Helm? - -```console - -# output of `helm version` command -version.BuildInfo{.... - -``` - - -## Any non-default Helm values? - -
-click to expand - -```yaml -## PASTE BELOW THIS LINE -## -------------------------------------------------- - -## non-default helm values (in YAML format) -airflow: - ... -workers: - ... - -## -------------------------------------------------- -## PASTE ABOVE THIS LINE -``` - -
\ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/01_bug_report.yml b/.github/ISSUE_TEMPLATE/01_bug_report.yml new file mode 100644 index 00000000..7dd7cbde --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01_bug_report.yml @@ -0,0 +1,82 @@ +name: Bug Report +description: Report something not working properly! +labels: [ "bug" ] +body: + - type: markdown + attributes: + value: | + # Bug Report + + Thanks for helping make the project better! + - type: checkboxes + attributes: + label: Checks + options: + - label: I have checked for [existing issues](https://github.com/airflow-helm/charts/issues). + required: true + - label: This report is about the [user-community Airflow Helm Chart](https://github.com/airflow-helm/charts/tree/main/charts/airflow). + required: true + - type: input + id: chart-version + attributes: + label: Chart Version + placeholder: X.X.X + validations: + required: true + - type: textarea + id: kubernetes-version + attributes: + label: Kubernetes Version + description: Output of `kubectl version` command. + placeholder: | + Client Version: version.Info{Major:"X", Minor:"XX", GitVersion:"vX.X.X", ...} + Server Version: version.Info{Major:"X", Minor:"XX", GitVersion:"vX.X.X", ...} + render: shell + validations: + required: true + - type: textarea + id: helm-version + attributes: + label: Helm Version + description: Output of `helm version` command. + placeholder: version.BuildInfo{Version:"vX.X.X", GitCommit:"XXXXXXXXXXXXXXX", ...} + render: shell + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: The __context__ the problem occurred in, and an __overview__ of what went wrong. + placeholder: I was trying to... but then... + validations: + required: true + - type: textarea + id: logs + attributes: + label: Relevant Logs + description: Outputs of commands like `kubectl logs my-pod` or `kubectl describe pods my-pod`. + placeholder: | + * Include any relevant log outputs here * + render: shell + - type: textarea + id: custom-helm-values + attributes: + label: Custom Helm Values + description: Your non-default Helm values (in YAML format). + placeholder: | + ################################### + ## CONFIG | Airflow Configs + ################################### + airflow: + image: + ... + config: + ... + + ################################### + ## COMPONENT | Airflow Scheduler + ################################### + scheduler: + ... + render: yaml \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/02_feature_request.md b/.github/ISSUE_TEMPLATE/02_feature_request.md deleted file mode 100644 index f7b011d2..00000000 --- a/.github/ISSUE_TEMPLATE/02_feature_request.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -name: Feature Request -about: Suggest an idea for the project! -title: '' -labels: 'enhancement' -assignees: '' ---- - - - -## What is your feature request? - -I would like the chart to... - - -## Have you considered any alternatives? - -Alternatively the chart could... \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/02_feature_request.yml b/.github/ISSUE_TEMPLATE/02_feature_request.yml new file mode 100644 index 00000000..b5714402 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02_feature_request.yml @@ -0,0 +1,40 @@ +name: Feature Request +description: Suggest an idea for the project! +labels: [ "enhancement" ] +body: + - type: markdown + attributes: + value: | + # Feature Request + + Thanks for helping make the project better! + - type: checkboxes + attributes: + label: Checks + options: + - label: I have checked for [existing issues](https://github.com/airflow-helm/charts/issues). + required: true + - type: textarea + id: motivation + attributes: + label: Motivation + description: What has motivated your request? + placeholder: | + * This is the most important part of the request * + + * Help us understand what you are trying to achieve, try to seperate it from any implementation you may have in mind * + validations: + required: true + - type: textarea + id: implementation + attributes: + label: Implementation + description: What is your proposed implementation? + placeholder: | + * It's fine to leave this blank if you don't have an implementation already in mind * + - type: checkboxes + attributes: + label: Are you willing & able to help? + options: + - label: I am able to submit a PR! + - label: I can help test the feature! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/03_docs_issue.yml b/.github/ISSUE_TEMPLATE/03_docs_issue.yml new file mode 100644 index 00000000..25f2c643 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03_docs_issue.yml @@ -0,0 +1,29 @@ +name: Docs Issue +description: Raise an issue about documentation! +labels: [ "documentation" ] +body: + - type: markdown + attributes: + value: | + # Docs Issue + + Thanks for helping make the docs better! + - type: checkboxes + attributes: + label: Checks + options: + - label: I have checked for [existing issues](https://github.com/airflow-helm/charts/issues). + required: true + - type: textarea + id: description + attributes: + label: Description + description: An overview of the documentation issue. + validations: + required: true + - type: checkboxes + attributes: + label: Are you willing & able to help? + options: + - label: I am able to submit a PR! + - label: I can provide feedback! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/03_question.md b/.github/ISSUE_TEMPLATE/03_question.md deleted file mode 100644 index 3786c274..00000000 --- a/.github/ISSUE_TEMPLATE/03_question.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: Question -about: Ask something about the project! -title: '' -labels: 'question' -assignees: '' ---- - - - -## What is your question? - -I would like to know... \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/04_documentation.md b/.github/ISSUE_TEMPLATE/04_documentation.md deleted file mode 100644 index 50acacb9..00000000 --- a/.github/ISSUE_TEMPLATE/04_documentation.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -name: Documentation -about: Raise an issue that only relates to documentation. -title: '' -labels: 'documentation' -assignees: '' ---- - - - -## What is your documentation issue? - -The documentation should... \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/04_question.yml b/.github/ISSUE_TEMPLATE/04_question.yml new file mode 100644 index 00000000..f5fef00f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04_question.yml @@ -0,0 +1,24 @@ +name: Question +description: Ask something about the project! +labels: [ "question" ] +body: + - type: markdown + attributes: + value: | + # Question + - type: checkboxes + attributes: + label: Checks + options: + - label: I have checked for [existing issues](https://github.com/airflow-helm/charts/issues). + required: true + - label: I have looked through the [FAQ](https://github.com/airflow-helm/charts/tree/main/charts/airflow#faq---airflow). + required: true + - type: textarea + id: question + attributes: + label: Question + placeholder: | + I would like to understand... + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 00000000..ec4bb386 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file