From 291b5eba8219899195f508f05d17d3a827a782e4 Mon Sep 17 00:00:00 2001 From: kezhenxu94 Date: Fri, 10 Sep 2021 00:23:54 +0800 Subject: [PATCH] Adopt new GitHub issue template (#6153) --- .github/ISSUE_TEMPLATE/bug-report.yml | 111 ++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 34 ------ .github/ISSUE_TEMPLATE/feature-request.yml | 81 +++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 26 ---- .../ISSUE_TEMPLATE/improvement_suggestion.md | 23 ---- .github/ISSUE_TEMPLATE/question.md | 21 ---- .github/ISSUE_TEMPLATE/question.yml | 74 ++++++++++++ 7 files changed, 266 insertions(+), 104 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/improvement_suggestion.md delete mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000000..2f1d83fa8f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,111 @@ +# +# 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. +# + +name: Bug report +title: "[Bug] [Module Name] Bug title " +description: Problems and issues with code of Apache Dolphinscheduler +labels: [ "bug" ] +body: + - type: markdown + attributes: + value: | + For better global communication, Please write in English. + + If you feel the description in English is not clear, then you can append description in Chinese, thanks! + + - type: checkboxes + attributes: + label: Search before asking + description: > + Please make sure to search in the [issues](https://github.com/apache/dolphinscheduler/issues?q=is%3Aissue) + first to see whether the same issue was reported already. + options: + - label: > + I had searched in the [issues](https://github.com/apache/dolphinscheduler/issues?q=is%3Aissue) and found + no similar issues. + required: true + + - type: textarea + attributes: + label: What happened + description: Describe what happened. + placeholder: > + Please provide the context in which the problem occurred and explain what happened + validations: + required: true + + - type: textarea + attributes: + label: What you expected to happen + description: What do you think went wrong? + placeholder: > + Please explain why you think the behaviour is erroneous. It is extremely helpful if you copy and paste + the fragment of logs showing the exact error messages or wrong behaviour and screenshots for + UI problems. You can include files by dragging and dropping them here. + + **NOTE**: please copy and paste texts instead of taking screenshots of them for easy future search. + validations: + required: true + + - type: textarea + attributes: + label: How to reproduce + description: > + What should we do to reproduce the problem? If you are not able to provide a reproducible case, + please open a [Discussion](https://github.com/apache/dolphinscheduler/discussions) instead. + placeholder: > + Please make sure you provide a reproducible step-by-step case of how to reproduce the problem + as minimally and precisely as possible. Keep in mind we do not have access to your deployment. + Remember that non-reproducible issues will be closed! Opening a discussion is recommended as a + first step. + validations: + required: true + + - type: textarea + attributes: + label: Anything else + description: Anything else we need to know? + placeholder: > + How often does this problem occur? (Once? Every time? Only when certain conditions are met?) + Any relevant logs to include? Put them here inside fenced + ``` ``` blocks or inside a collapsable details tag if it's too long: +
x.log lots of stuff
+ + - type: checkboxes + attributes: + label: Are you willing to submit PR? + description: > + This is absolutely not required, but we are happy to guide you in the contribution process + especially if you already have a good understanding of how to implement the fix. + Dolphinscheduler is a totally community-driven project and we love to bring new contributors in. + options: + - label: Yes I am willing to submit a PR! + + - type: checkboxes + attributes: + label: Code of Conduct + description: | + The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it. + options: + - label: > + I agree to follow this project's + [Code of Conduct](https://www.apache.org/foundation/policies/conduct) + required: true + + - type: markdown + attributes: + value: "Thanks for completing our form!" diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index c8c90dc26a..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[Bug][Module Name] Bug title " -assignees: '' - ---- - -**For better global communication, Please describe it in English. If you feel the description in English is not clear, then you can append description in Chinese(just for Mandarin(CN)), thx! ** -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior, for example: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - - -**Which version of Dolphin Scheduler:** - -[1.1.0-preview] - -**Additional context** -Add any other context about the problem here. - -**Requirement or improvement** -- Please describe about your requirements or improvement suggestions. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000000..bc79e1cc1d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,81 @@ +# +# 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. +# +name: Feature request +description: Suggest an idea for this project +title: "[Feature][Module Name] Feature title" +labels: [ "feature" ] +body: + - type: markdown + attributes: + value: | + For better global communication, Please write in English. + + If you feel the description in English is not clear, then you can append description in Chinese, thanks! + + - type: checkboxes + attributes: + label: Search before asking + description: > + Please make sure to search in the [issues](https://github.com/apache/dolphinscheduler/issues?q=is%3Aissue) first + to see whether the same feature was requested already. + options: + - label: > + I had searched in the [issues](https://github.com/apache/dolphinscheduler/issues?q=is%3Aissue) and found no + similar feature requirement. + required: true + + - type: textarea + attributes: + label: Description + description: A short description of your feature + + - type: textarea + attributes: + label: Use case + description: What do you want to happen? + placeholder: > + Rather than telling us how you might implement this feature, try to take a + step back and describe what you are trying to achieve. + + - type: textarea + attributes: + label: Related issues + description: Is there currently another issue associated with this? + + - type: checkboxes + attributes: + label: Are you willing to submit a PR? + description: > + This is absolutely not required, but we are happy to guide you in the contribution process + especially if you already have a good understanding of how to implement the feature. + DolphinScheduler is a totally community-driven project and we love to bring new contributors in. + options: + - label: Yes I am willing to submit a PR! + + - type: checkboxes + attributes: + label: Code of Conduct + description: | + The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it. + options: + - label: | + I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct) + required: true + + - type: markdown + attributes: + value: "Thanks for completing our form!" diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 37aebf4a13..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[Feature][Module Name] Feature title" -assignees: '' - ---- - -*For better global communication, please give priority to using English description, thx! * - -*Please review https://dolphinscheduler.apache.org/en-us/community/development/issue.html when describe an issue.* - -**Describe the feature** -A clear and concise description of what the feature is. - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/improvement_suggestion.md b/.github/ISSUE_TEMPLATE/improvement_suggestion.md deleted file mode 100644 index d01936b19d..0000000000 --- a/.github/ISSUE_TEMPLATE/improvement_suggestion.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: Improvement suggestion -about: Improvement suggestion for this project -title: "[Improvement][Module Name] Improvement title" -assignees: '' - ---- - -*For better global communication, please give priority to using English description, thx! * - -*Please review https://dolphinscheduler.apache.org/en-us/community/development/issue.html when describe an issue.* - -**Describe the question** -A clear and concise description of what the improvement is. - -**What are the current deficiencies and the benefits of improvement** -- A clear and concise description of the current deficiencies and the benefits of this improvement. - -**Which version of DolphinScheduler:** - -[1.1.0-preview] - -**Describe alternatives you've considered** -A clear and concise description of any alternative improvement solutions you've considered. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 961d82476e..0000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Question -about: Have a question wanted to be help -title: "[Question] Question title" -assignees: '' - ---- - -**For better global communication, Please describe it in English. If you feel the description in English is not clear, then you can append description in Chinese(just for Mandarin(CN)), thx! ** -**Describe the question** -A clear and concise description of what the question is. - - -**Which version of DolphinScheduler:** - -[1.1.0-preview] - -**Additional context** -Add any other context about the problem here. - -**Requirement or improvement** -- Please describe about your requirements or improvement suggestions. diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000000..1883190680 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,74 @@ +# +# 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. +# +name: Question +description: Ask a question +title: "[Question] Question title" +labels: [ "question" ] +body: + - type: markdown + attributes: + value: | + For better global communication, Please write in English. + + If you feel the description in English is not clear, then you can append description in Chinese, thanks! + + - type: checkboxes + attributes: + label: Search before asking + description: > + Please make sure to search in the [issues](https://github.com/apache/dolphinscheduler/issues?q=is%3Aissue) first + to see whether the same feature was requested already. + options: + - label: > + I had searched in the [issues](https://github.com/apache/dolphinscheduler/issues?q=is%3Aissue) and found no + similar feature requirement. + required: true + + - type: textarea + attributes: + label: Description + description: A short description of your question + validations: + required: true + + - type: textarea + attributes: + label: DolphinScheduler Version + description: What version of DolphinScheduler? + placeholder: > + The version of DolphinScheduler. + validations: + required: true + + - type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. + + - type: checkboxes + attributes: + label: Code of Conduct + description: | + The Code of Conduct helps create a safe space for everyone. We require that everyone agrees to it. + options: + - label: | + I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct) + required: true + + - type: markdown + attributes: + value: "Thanks for completing our form!"