From 1cf9185e27bc8be7153de9b37554798732222280 Mon Sep 17 00:00:00 2001 From: Daan Hoogland Date: Tue, 14 Jan 2025 17:21:44 +0100 Subject: [PATCH 1/3] feature and bug templates --- .github/ISSUE_TEMPLATE/bug.yml | 23 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yaml | 9 ++++++++ 2 files changed, 32 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000000..81ad0db55df4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,23 @@ +description: "Thank you for reporting a bug!" +name: bug +title: "[SHORT PROBLEM DESCRIPTION]" +labels: issue, needs-testing +body: +- type: markdown + attributes: + value: "## Welcome, please describe your problem below;" +- type: textarea + attributes: + label: problem + value: the long description of your problem +- type: textarea + attributes: + label: reproduction steps + value: | + 1. + 2. + 3. + ... +- type: textarea + attributes: + label: "What to do about it?" diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 000000000000..a4b6d86ab8b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,9 @@ +description: "Thank you for your new feature idea!" +name: feature +title: "[SHORT FUNCTIONAL DESCRIPTION]" +labels: new +body: +- type: textarea + attributes: + label: "As a User/Admin/Operator I would like to ..." + value: the long description of your functionality From 38c4cd6e89151f9795ca65280321d08c684dd5d4 Mon Sep 17 00:00:00 2001 From: dahn Date: Wed, 15 Jan 2025 15:38:12 +0100 Subject: [PATCH 2/3] licenses --- .github/ISSUE_TEMPLATE/bug.yml | 16 ++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yaml | 16 ++++++++++++++++ 2 files changed, 32 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 81ad0db55df4..eb5c3d42c293 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -1,3 +1,19 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. description: "Thank you for reporting a bug!" name: bug title: "[SHORT PROBLEM DESCRIPTION]" diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index a4b6d86ab8b0..ac3c2f9a56a9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -1,3 +1,19 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. description: "Thank you for your new feature idea!" name: feature title: "[SHORT FUNCTIONAL DESCRIPTION]" From e0af13738d2542f542a5219c8ae967b597a28632 Mon Sep 17 00:00:00 2001 From: dahn Date: Wed, 15 Jan 2025 15:44:13 +0100 Subject: [PATCH 3/3] text updates as suggested by @nvazquez --- .github/ISSUE_TEMPLATE/bug.yml | 6 +++--- .github/ISSUE_TEMPLATE/feature_request.yaml | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index eb5c3d42c293..8044cc041df0 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -17,7 +17,7 @@ description: "Thank you for reporting a bug!" name: bug title: "[SHORT PROBLEM DESCRIPTION]" -labels: issue, needs-testing +labels: bug, needs-triageing body: - type: markdown attributes: @@ -25,10 +25,10 @@ body: - type: textarea attributes: label: problem - value: the long description of your problem + value: The long description of your problem - type: textarea attributes: - label: reproduction steps + label: The steps to reproduce the bug value: | 1. 2. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index ac3c2f9a56a9..90de11698861 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -21,5 +21,5 @@ labels: new body: - type: textarea attributes: - label: "As a User/Admin/Operator I would like to ..." - value: the long description of your functionality + label: "The required feature described as a wish" + value: As a User/Admin/Operator I would like to , ... have the system make my morning coffee.