diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000000..7bca12d3d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,135 @@ +# +# 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. +# + +# See https://gh-community.github.io/issue-template-feedback/structured/ + +name: Uniffle Bug Report +title: "[Bug] " +description: Describe the bug you encountered with Apache Uniffle +labels: [ "kind:bug,priority:major" ] +body: + - type: markdown + attributes: + value: | + Thank you for finding the time to report the issue! We really appreciate the community's efforts to improve Uniffle. + + It doesn't really matter whether what you are reporting is a bug or not, just feel free to share the problem you have + encountered with the community. For best practices, if it is indeed a bug, please try your best to provide the reproducible + steps. If you want to ask questions or share ideas, please [subscribe to our mailing list](mailto:dev-subscribe@uniffle.apache.org) + and send emails to [our mailing list](mailto:dev@uniffle.apache.org), you can also head to our + [Discussions](https://github.com/apache/incubator-uniffle/discussions) tab. + + - 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: checkboxes + attributes: + label: Search before asking + options: + - label: > + I have searched in the [issues](https://github.com/apache/incubator-uniffle/issues?q=is%3Aissue) and found no similar + issues. + required: true + + - type: textarea + attributes: + label: Describe the bug + placeholder: > + Please provide the context in which the problem occurred and explain what happened + validations: + required: true + + - type: input + id: versions + attributes: + label: Affects Version(s) + description: Which versions of uniffle are affected by this bug? + placeholder: > + e.g. master/0.5.0/0.4.0/... + validations: + required: true + + - type: textarea + id: s-logs + attributes: + label: Uniffle Server Log Output + description: What do you see when you check the log of Uniffle server instance? + placeholder: > + Tips: check the server log under the RSS_HOME/logs/ folder. It is extremely helpful if you copy and paste + the fragment of logs showing the exact error messages of Uniffle server. + render: logtalk + validations: + required: false + + - type: textarea + id: e-logs + attributes: + label: Uniffle Engine Log Output + description: What do you see when you check the log of Uniffle engine (eg:Spark, MapReduce) innstance? + placeholder: > + Tips: check the engine log folder. It is extremely helpful if you copy and paste + the fragment of logs showing the exact error messages of Uniffle engines(eg:Spark, MapReduce). + render: logtalk + validations: + required: false + + - type: textarea + id: s-configurations + attributes: + label: Uniffle Server Configurations + placeholder: > + Custom configurations you specified in server.conf at server-side + render: yaml + validations: + required: false + + - type: textarea + id: e-configurations + attributes: + label: Uniffle Engine Configurations + placeholder: > + Custom configurations you specified in engine configuration(eg:spark-defaults.conf, mapred-site.xml) at engine-side + render: yaml + validations: + required: false + + - type: textarea + attributes: + label: Additional context + placeholder: Anything else we need to know. + validations: + required: false + + - type: checkboxes + attributes: + label: Are you willing to submit PR? + description: > + A pull request is optional, but we are glad to help you in the contribution process + especially if you already know a good understanding of how to implement the fix. + Uniffle is a community-driven project and we love to bring new contributors in. + options: + - label: Yes I am willing to submit a PR! + + - type: markdown + attributes: + value: "Thanks for taking the time to fill out this bug report!" diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..6fa38fd5a3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,28 @@ +# +# 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: false +contact_links: + - name: Ask a question or get support + url: https://github.com/apache/incubator-uniffle/discussions/categories/q-a + about: Ask a question or request support for using Apache Uniffle + - name: Tell us your success story or use case + url: https://github.com/apache/incubator-uniffle/discussions/categories/announcements + about: Tell us your success story or use case using Apache Uniffle + - name: Uniffle project improvement proposal + url: https://github.com/apache/incubator-uniffle/discussions/categories/ideas + about: a.k.a UPIP diff --git a/.github/ISSUE_TEMPLATE/doc-improvement-report.yml b/.github/ISSUE_TEMPLATE/doc-improvement-report.yml new file mode 100644 index 0000000000..9ee0ba9f30 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/doc-improvement-report.yml @@ -0,0 +1,97 @@ +# +# 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: Uniffle Doc Improvement Report +title: "[DOCS] " +description: Fix errors, or improve the content or refactor architecture of online documentation +labels: ["kind:documentation"] +body: + - type: markdown + attributes: + value: | + Thank you for finding the time to report the problem! We really appreciate the community efforts to improve Uniffle. + + - 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: checkboxes + attributes: + label: Search before asking + options: + - label: > + I have searched in the [issues](https://github.com/apache/incubator-uniffle/issues?q=is%3Aissue) and found no similar + issues. + required: true + + - type: textarea + attributes: + label: Which parts of the documentation do you think need improvement? + description: Please describe the details with documentation you have. + placeholder: > + Please include links to the documentation that you want to improve and possibly screenshots showing + the details. Explain why do you think it needs to improve. Make sure you include view of the target + audience of the documentation. Please explain why you think the docs are wrong. + + - type: input + id: versions + attributes: + label: Affects Version(s) + description: Which versions of Uniffle Documentation are affected by this issue? + placeholder: > + e.g. master/0.5.0/0.4.0/... + validations: + required: true + + - type: textarea + attributes: + label: Improving the documentation + description: How do you think the documentation can be improved? + placeholder: > + Please explain how you think the documentation could be improved. Ideally specify where a new or missing + documentation should be added and what kind of information should be included. Sometimes people + writing the documentation do not realise that some assumptions they have might not be in the heads + of the reader, so try to explain exactly what you would like to see in the docs and why. + + - 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 foldable details tag if it's long: +
x.log lots of stuff
+ + - type: checkboxes + attributes: + label: Are you willing to submit PR? + description: > + A pull request is optional, but we are glad to help you in the contribution process + especially if you already know a good understanding of how to implement the fix. + Uniffle is a community-driven project and we love to bring new contributors in. + options: + - label: Yes I am willing to submit a PR! + + - type: markdown + attributes: + value: "Thanks for taking the time to fill out this Doc improvement report!" diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000000..f6a21e14e3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,93 @@ +# +# 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: Uniffle Feature Request +title: "[FEATURE] " +description: Suggest an idea for Apache Uniffle +labels: [ "kind:feature,priority:major" ] +body: + - type: markdown + attributes: + value: | + You are very welcome to propose new features. Your brilliant ideas keep Apache Uniffle evolving. + + - 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: checkboxes + attributes: + label: Search before asking + options: + - label: > + I have searched in the [issues](https://github.com/apache/incubator-uniffle/issues?q=is%3Aissue) and found no similar + issues. + required: true + + - type: textarea + attributes: + label: Describe the feature + description: What is it? + placeholder: > + Please describe the feature you want here. + validations: + required: true + + - type: textarea + attributes: + label: Motivation + description: Why should it be implemented? + placeholder: > + Please describe your motivation for requesting this feature. + validations: + required: false + + - type: textarea + attributes: + label: Describe the solution + description: How could it be implemented? + placeholder: > + Please describe the solution to implement the new feature if you have any. + validations: + required: false + + - type: textarea + attributes: + label: Additional context + placeholder: > + Anything else we need to know. + validations: + required: false + + - type: checkboxes + attributes: + label: Are you willing to submit PR? + description: > + A pull request is optional, but we are glad to help you in the contribution process + especially if you already have a grip on how to implement the new feature. + Uniffle is a community-driven project and we love to bring new contributors in. + options: + - label: Yes I am willing to submit a PR! + + - type: markdown + attributes: + value: "Thanks for taking the time to fill out this feature request form!" diff --git a/.github/ISSUE_TEMPLATE/flaky-test-report.yml b/.github/ISSUE_TEMPLATE/flaky-test-report.yml new file mode 100644 index 0000000000..ccf4661100 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/flaky-test-report.yml @@ -0,0 +1,85 @@ +# +# 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: Uniffle Flaky Test Report +title: "Flaky Test: " +description: Describe the flaky test you encountered with Apache Uniffle +labels: ["kind:bug,kind:test,priority:major"] +body: + - type: markdown + attributes: + value: | + Thank you for finding the time to report the issue! We really appreciate the community's efforts to improve Uniffle. + + - 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: checkboxes + attributes: + label: Search before asking + options: + - label: > + I have searched in the [issues](https://github.com/apache/incubator-uniffle/issues?q=is%3Aissue) and found no similar + issues. + required: true + + - type: textarea + attributes: + label: Describe the flaky test + placeholder: > + Please provide the suite, test name and log in which the problem occurred + validations: + required: true + + - type: textarea + attributes: + label: Actions URL + placeholder: > + Please provide some link about failure like GitHub Actions url + + https://github.com/apache/incubator-uniffle/actions/runs/XXX + + https://github.com/apache/incubator-uniffle/runs/XXX + validations: + required: true + + - type: textarea + attributes: + label: Parent issue + value: "#1733" + validations: + required: false + + - type: checkboxes + attributes: + label: Are you willing to submit PR? + description: > + A pull request is optional, but we are glad to help you in the contribution process + especially if you already know a good understanding of how to implement the fix. + Uniffle is a community-driven project and we love to bring new contributors in. + options: + - label: Yes I am willing to submit a PR! + + - type: markdown + attributes: + value: "Thanks for taking the time to fill out this bug report!" diff --git a/.github/ISSUE_TEMPLATE/improvement.yml b/.github/ISSUE_TEMPLATE/improvement.yml new file mode 100644 index 0000000000..15b99a6e02 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improvement.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. +# + +# See https://gh-community.github.io/issue-template-feedback/structured/ + +name: Uniffle Improvement +title: "[Improvement] " +description: Suggest an improvement on performance, code quality, user experience, etc +labels: [ "improvement" ] +body: + - type: markdown + attributes: + value: | + Thank you for contributing to Apache Uniffle! Your opinions are deeply valued by the community. + + - 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: checkboxes + attributes: + label: Search before asking + options: + - label: > + I have searched in the [issues](https://github.com/apache/incubator-uniffle/issues?q=is%3Aissue) and found no similar + issues. + required: true + + - type: textarea + attributes: + label: What would you like to be improved? + placeholder: > + Please describe the problem you see and how it is needed to be improved. + validations: + required: true + + - type: textarea + attributes: + label: How should we improve? + placeholder: > + Please provide the solution if you have thoughts. + validations: + required: false + + - type: checkboxes + attributes: + label: Are you willing to submit PR? + description: > + A pull request is optional, but we are glad to help you in the contribution process + especially if you already know a good understanding of how to implement the fix. + Uniffle is a community-driven project and we love to bring new contributors in. + options: + - label: Yes I am willing to submit a PR! + + - type: markdown + attributes: + value: "Thanks for taking the time to create this improvement issue!" diff --git a/.github/ISSUE_TEMPLATE/subtask.yml b/.github/ISSUE_TEMPLATE/subtask.yml new file mode 100644 index 0000000000..200621a6f8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/subtask.yml @@ -0,0 +1,70 @@ +# +# 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: Subtask +title: "[Subtask] " +description: A subtask issue +labels: [ "kind:subtask" ] +body: + + - 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: checkboxes + attributes: + label: Search before asking + options: + - label: > + I have searched in the [issues](https://github.com/apache/incubator-uniffle/issues) and found no similar + issues. + required: true + + - type: textarea + attributes: + label: Describe the subtask + placeholder: > + Please describe the content of the subtask clearly and concisely. + validations: + required: true + + - type: textarea + attributes: + label: Parent issue + placeholder: > + Please put the parent issue link here. + validations: + required: true + + - type: checkboxes + attributes: + label: Are you willing to submit PR? + description: > + A pull request is optional, but we are glad to help you in the contribution process + especially if you already have a grip on how to implement the new feature. + Uniffle is a community-driven project and we love to bring new contributors in. + options: + - label: Yes I am willing to submit a PR! + + - type: markdown + attributes: + value: "Thanks for taking the time to propose an subtask issue!" diff --git a/.github/ISSUE_TEMPLATE/umbrella.yml b/.github/ISSUE_TEMPLATE/umbrella.yml new file mode 100644 index 0000000000..725414a95c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/umbrella.yml @@ -0,0 +1,80 @@ +# +# 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: Umbrella +title: "[Umbrella] " +description: An umbrella issue with multiple sub-tasks +labels: [ "kind:umbrella,priority:major" ] +body: + + - 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: checkboxes + attributes: + label: Search before asking + options: + - label: > + I have searched in the [issues](https://github.com/apache/incubator-uniffle/issues) and found no similar + issues. + required: true + + - type: textarea + attributes: + label: Describe the proposal + description: > + Please put the related link here if it is a [UPIP](https://uniffle.apache.org/improvement-proposals.html). + placeholder: > + Please describe the content of the proposal clearly and concisely. + validations: + required: true + + - type: textarea + attributes: + label: Task list + description: > + For more details, please refer to [github docs](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-task-lists). + placeholder: > + Please create sub-tasks with the pre-create issues here and @ the assignees if you know any of them. A simple example is as follows: + - [ ] #1 + - [ ] #11 @user1 + - [ ] #12 + - [ ] #13 + - [ ] #2 @user2 + - [ ] #3 + validations: + required: true + + - type: checkboxes + attributes: + label: Are you willing to submit PR? + description: > + A pull request is optional, but we are glad to help you in the contribution process + especially if you already have a grip on how to implement the new feature. + Uniffle is a community-driven project and we love to bring new contributors in. + options: + - label: Yes I am willing to submit a PR! + + - type: markdown + attributes: + value: "Thanks for taking the time to propose an umbrella issue!"