From dcbb4dec03415003a10b1f0ad2624165e4333194 Mon Sep 17 00:00:00 2001 From: lexluo09 <39718951+lexluo09@users.noreply.github.com> Date: Wed, 26 Jun 2024 10:47:04 +0800 Subject: [PATCH] (improvement)(project) Add issue and pull request templates. (#1232) --- .github/ISSUE_TEMPLATE/bug_report.yml | 89 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/enhancement.yml | 56 ++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 60 +++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 36 +++++++++ 5 files changed, 246 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..3d4aea242 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,89 @@ +name: SuperSonic Bug report +title: "[Bug] " +description: Problems and issues with code of SuperSonic +labels: ["kind/bug"] +body: + - type: markdown + attributes: + value: | + Thank you very much for submitting feedback to SuperSonic to help SuperSonic develop better. + + If it is an idea or help wanted, please go to: + [Github Discussion](https://github.com/tencentmusic/supersonic/discussions) + + - type: checkboxes + attributes: + label: Search before asking + description: > + Please make sure to search in the [issues](https://github.com/tencentmusic/supersonic/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/tencentmusic/supersonic/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 SuperSonic 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 000000000..ef1eccec6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Ask a question or get support + url: https://github.com/tencentmusic/supersonic/discussions/ + about: Ask a question or request support for using SuperSonic diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 000000000..9fb52a947 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,56 @@ +name: SuperSonic enhancement +description: Add an enhanment for SuperSonic +title: "[Enhancement] " +labels: ["kind/enhancement"] +body: + - type: markdown + attributes: + value: | + Thank you very much for your good enhancement for SuperSonic. + - type: checkboxes + attributes: + label: Search before asking + description: > + Please make sure to search in the [issues](https://github.com/tencentmusic/supersonic/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/tencentmusic/supersonic/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 SuperSonic 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 000000000..3981bd1fd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,60 @@ +name: SuperSonic feature request +description: Suggest an idea for SuperSonic +title: "[Feature] " +labels: ["kind/feature"] +body: + - type: markdown + attributes: + value: | + Thank you very much for your good ideas and suggestions for SuperSonic + + - type: checkboxes + attributes: + label: Search before asking + description: > + Please make sure to search in the [issues](https://github.com/tencentmusic/supersonic/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/tencentmusic/supersonic/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 SuperSonic 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 000000000..b39e2d4ba --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,36 @@ +# Pull Request Template + +## Description + +Please include a summary of the change and which issue is fixed. Also include relevant motivation and context. List any dependencies that are required for this change. + +## Type of change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +## How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. + +- [ ] Test A +- [ ] Test B + +## Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules + +## Additional information + +Any additional information, configuration or data that might be necessary to reproduce the issue. \ No newline at end of file