From 1485c6fba29bbab5688f535bfb0b44d9ede154e8 Mon Sep 17 00:00:00 2001 From: Jiajie Zhong Date: Wed, 6 Jul 2022 11:52:55 +0800 Subject: [PATCH] Add doc issue template (#10804) close: #8201 --- .github/ISSUE_TEMPLATE/document.yml | 73 +++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/document.yml diff --git a/.github/ISSUE_TEMPLATE/document.yml b/.github/ISSUE_TEMPLATE/document.yml new file mode 100644 index 0000000000..0430691e21 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/document.yml @@ -0,0 +1,73 @@ +# +# 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: Documentation Related +description: Suggest an improvement or report a bug for this project's Documentation +title: "[Doc][Module Name] Documentation bug or improvement" +labels: [ "document", "Waiting for reply" ] +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 why your find in our document. + + - type: textarea + attributes: + label: Documentation Links + description: Copy and paste one or more links of this documentation issue. + + - 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 improvement. + 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!"