diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..bd860c0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,108 @@ +# +# 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: Doris Operator Bug report +title: "[Bug] " +description: Problems and issues with code of Apache Doris Operator +labels: ["kind/bug"] +body: + - type: markdown + attributes: + value: | + Thank you very much for submitting feedback to Doris Operator to help Doris Operator develop better. + + If it is an idea or help wanted, please go to: + + 1. [Dev Mail List](mailto:dev@doris.apache.org): This will be your FASTEST way to get help![How to subscribe](mailto:dev-subscribe@doris.apache.org) + 2. [Github Discussion](https://github.com/apache/doris-operator/discussions) + + - type: checkboxes + attributes: + label: Search before asking + description: > + Please make sure to search in the [issues](https://github.com/apache/doris-operator/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/doris-operator/issues?q=is%3Aissue) and found no similar + issues. + required: true + + - type: textarea + attributes: + label: Version + description: What is the current version + placeholder: > + Please provide the version you are using. + If it is the trunk version, please input commit id. + validations: + required: true + + - type: textarea + attributes: + label: What's Wrong? + description: Describe the bug. + placeholder: > + Describe the specific problem, the more detailed the better. + validations: + required: true + + - type: textarea + attributes: + label: What You Expected? + validations: + required: true + + - type: textarea + attributes: + label: How to Reproduce? + placeholder: > + Please try to give reproducing steps to facilitate quick location of the problem. + + - What actions were performed + - Table building statement + - Import statement + - Cluster information: number of nodes, configuration, etc. + + If it is hard to reproduce, please also explain the general scene. + + - type: textarea + attributes: + label: Anything Else? + + - type: checkboxes + attributes: + label: Are you willing to submit PR? + description: > + We very much look forward to developers or users to help solve the Doris Operator problem together. + If you are willing to submit a PR to fix this problem, please tick it. + 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/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..8490f88 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,22 @@ +# +# 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. +# + +blank_issues_enabled: true +contact_links: + - name: Ask a question or get support + url: https://github.com/apache/doris-operator/discussions + about: Ask a question or request support for using Apache Doris Operator diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 0000000..a747068 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,76 @@ +# +# 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: Doris Operator enhancement +description: Add an enhanment for Apache Doris Operator +title: "[Enhancement] " +labels: ["kind/enhancement"] +body: + - type: markdown + attributes: + value: | + Thank you very much for your good enhancement for Doris Operator. + + Please help sync to the [Dev Mail List](mailto:dev@doris.apache.org). You will get FASTER help![How to subscribe](mailto:dev-subscribe@doris.apache.org) + + - type: checkboxes + attributes: + label: Search before asking + description: > + Please make sure to search in the [issues](https://github.com/apache/doris-operator/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/doris-operator/issues?q=is%3Aissue) and found no similar + issues. + required: true + + - type: textarea + attributes: + label: Description + description: Describe the enhancement what you want, including motivation if it exists. + + - type: textarea + attributes: + label: Solution + placeholder: > + Add overview of proposed solution. + + Add related materials like links if they exist. + + - type: checkboxes + attributes: + label: Are you willing to submit PR? + description: > + We very much look forward to developers or users to help develop the Doris Operator together. + If you are willing to submit a PR to implement this feature, please tick it. + 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.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..bdfab84 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,78 @@ +# +# 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: Doris Operator feature request +description: Suggest an idea for Apache Doris Operator +title: "[Feature] " +labels: ["kind/feature"] +body: + - type: markdown + attributes: + value: | + Thank you very much for your good ideas and suggestions for Doris Operator + + Please help sync to the [Dev Mail List](mailto:dev@doris.apache.org). You will get FASTER help![How to subscribe](mailto:dev-subscribe@doris.apache.org) + + - type: checkboxes + attributes: + label: Search before asking + description: > + Please make sure to search in the [issues](https://github.com/apache/doris-operator/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/doris-operator/issues?q=is%3Aissue) and found no similar + issues. + required: true + + - type: textarea + attributes: + label: Description + description: Describe your ideas and needs. + + - type: textarea + attributes: + label: Use case + placeholder: > + What problem does this feature mainly solve, or what scenarios it is suitable for. + + - type: textarea + attributes: + label: Related issues + description: Is there currently another issue associated with this? + + - type: checkboxes + attributes: + label: Are you willing to submit PR? + description: > + We very much look forward to developers or users to help develop the Doris Operator together. + If you are willing to submit a PR to implement this feature, please tick it. + 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/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..c7c4134 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,39 @@ +### What problem does this PR solve? + +Issue Number: close #xxx + +Related PR: #xxx + +Problem Summary: + +### Release note + +None + +### Check List (For Author) + +- Test + - [ ] Regression test + - [ ] Unit Test + - [ ] Manual test (add detailed scripts or steps below) + - [ ] No need to test or manual test. Explain why: + - [ ] This is a refactor/code format and no logic has been changed. + - [ ] Previous test can cover this change. + - [ ] No code files have been changed. + - [ ] Other reason + +- Behavior changed: + - [ ] No. + - [ ] Yes. + +- Does this need documentation? + - [ ] No. + - [ ] Yes. + +### Check List (For Reviewer who merge this PR) + +- [ ] Confirm the release note +- [ ] Confirm test cases +- [ ] Confirm document +- [ ] Add branch pick label +