From e4217838647c9870785e946ca46de885a1320cee Mon Sep 17 00:00:00 2001 From: cyclinder Date: Thu, 2 Nov 2023 17:16:47 +0800 Subject: [PATCH] Use github forms for issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 105 +++++++++++++++------- .github/ISSUE_TEMPLATE/ci-failure.md | 46 ++++++---- .github/ISSUE_TEMPLATE/doc.md | 43 ++++++--- .github/ISSUE_TEMPLATE/feature_request.md | 83 ++++++++--------- .github/ISSUE_TEMPLATE/usage.md | 32 ++++--- .github/PULL_REQUEST_TEMPLATE.md | 35 +++++--- 6 files changed, 223 insertions(+), 121 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index cca4293b74..b227b51b58 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,30 +1,75 @@ ---- -name: Bug report -about: Create a report to help us improve -title: 'software bug' -labels: issue/bug, issue/not-assign -assignees: 'Icarus9913, iiiceoo' - ---- - -**Describe the version** -version about: -1. spiderpool -2. kubernetes -3. what CNI and itsversion - - -**Describe the bug** -A clear and concise description of what the bug is. - -**How To Reproduce** -Steps to reproduce the issue: - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots and log** -If applicable, add screenshots and log to help explain your problem. - -**Additional context** -Add any other context about the problem here. +name: Bug Report +description: Report a bug that you encountered +labels: ["kind/bug"] +assignees: 'Icarus9913, cyclinder' +body: + - type: markdown + attributes: + value: | + Thanks for making this bug report. + + --- + - type: input + id: spiderpool-version + attributes: + label: Spiderpool Version + description: | + [e.g. v0.8.0] + validations: + required: true + - type: dropdown + id: type + attributes: + label: Bug Type + multiple: false + options: + - "IPAM" + - "Communication Issue" + - "Installation Issue" + - "Spiderpool-Controller" + - "Spiderpoo-Agent" + - "Coordinator" + - "Other" + validations: + required: true + - type: input + id: main-cni + attributes: + label: Main CNI + description: | + The primary CNI used in the deployment (e.g. macvlan,ipvlan,sriov) + validations: + required: true + - type: textarea + id: bug-report + attributes: + label: What happened? + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: exp-behaviour + attributes: + label: What did you expect to happen? + description: a clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: How to reproduce it (as minimally and precisely as possible) + description: Make sure that if you follow these steps again yourself the bug happens again. + placeholder: | + 1. Apply the following IPPool and Spidermultusconfig + 2. Annotate the annotations to Pod + 3. Show your Spidercoordinator in your cluster + validations: + required: true + - type: textarea + id: add-context + attributes: + label: Additional Context + description: Add any other context about the problem here. + validations: + required: false + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/ci-failure.md b/.github/ISSUE_TEMPLATE/ci-failure.md index 187df8299a..d823896674 100644 --- a/.github/ISSUE_TEMPLATE/ci-failure.md +++ b/.github/ISSUE_TEMPLATE/ci-failure.md @@ -1,18 +1,30 @@ ---- name: CI failure -about: Create a report to help us improve -title: 'CI failure' -labels: issue/ci-fail, issue/not-assign -assignees: 'Icarus9913, iiiceoo' - ---- - -Set title to be in the format CI: . - -Copy-paste the output the test failure. - -Upload the zip file generated from that test failure. - -Copy-paste the link of the CI build where that test failure has happen. - -Include any output from logs that you think may be relevant (to ease GitHub searches). +about: Report continuously failing tests or jobs in CI +labels: kind/ci-bug +assignees: 'ty-dc' +body: + - type: textarea + id: jobs + attributes: + label: Which tests are failing? + validations: + required: true + - type: textarea + id: since + attributes: + label: Since when has it been failing? + validations: + required: true + - type: input + id: testgrid + attributes: + label: Job's Link + - type: textarea + id: reason + attributes: + label: Reason for failure (if possible) + - type: textarea + id: additional + attributes: + label: Anything else we need to know? + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/doc.md b/.github/ISSUE_TEMPLATE/doc.md index 9ef2646e78..88931bad6a 100644 --- a/.github/ISSUE_TEMPLATE/doc.md +++ b/.github/ISSUE_TEMPLATE/doc.md @@ -1,13 +1,32 @@ ---- name: Documentation issue -about: documentation is not right -title: 'documentation issue' -labels: issue/doc, issue/not-assign -assignees: 'Icarus9913, iiiceoo' - ---- - -**Documentation issue** -1. miss documentation -2. documentation go wrong - +description: help us improve doc +labels: kind/doc +body: + - type: dropdown + id: opt-doc + attributes: + label: The Type of Document Issue + multiple: true + options: + - "Lacking" + - "Wrong" + - "outdated" + - "Other" + validations: + required: true + - type: textarea + id: doc + attributes: + label: What's wrong with this document? + placeholder: | + the document is outdated + validations: + required: true + - type: input + id: doc-path + attributes: + label: Document Path Or Link + description: | + [e.g. 0.13.9, 0.12.0] + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bccfa8d2ec..0065aba895 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,41 +1,42 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: 'feature' -labels: issue/feature, issue/not-assign -assignees: 'Icarus9913, iiiceoo' - ---- - -**1 Code requirement** - -necessary comment for your additional code , and comment for goDoc - -function and variable name must not be at will - -do not make huge function - -**2 observe opensource license** - -announce license at the beginning of file - -**3 sign-off your commit** - -your commit must be signed off - -**4 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 [...] - -**5 Describe the solution you'd like** - -A clear and concise description of what you want to happen. - -**6 Describe alternatives you've considered** - -A clear and concise description of any alternative solutions or features you've considered. - -**7 Additional context** - -Add any other context or screenshots about the feature request here. - +name: Feature Request +description: Provide supporting details for a feature in development Spiderpool +labels: kind/feature +assignees: 'Icarus9913, cyclinder' +body: + - type: markdown + attributes: + value: | + Thanks for making this suggestion! + + ___ + - type: textarea + attributes: + label: What would you like to be added? + description: A clear and concise description of what the problem is. + placeholder: I hope Spiderpool could be support... + validations: + required: true + - type: textarea + attributes: + label: Why is this needed? + placeholder: I think this feature can help us... + - type: textarea + attributes: + label: How to implement it (if possible)? + validations: + required: true + - type: textarea + attributes: + label: Additional context + description: Add any other context about the feature request here. + validations: + required: false + - type: checkboxes + attributes: + label: I've read and agree with the following + options: + - label: I've checked all open and closed issues and my request is not there. + required: true + - label: I've checked all open and closed pull requests and my request is not there. + required: true + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/usage.md b/.github/ISSUE_TEMPLATE/usage.md index 93c55c78c2..2ccb3000ed 100644 --- a/.github/ISSUE_TEMPLATE/usage.md +++ b/.github/ISSUE_TEMPLATE/usage.md @@ -1,12 +1,22 @@ ---- -name: usage issue -about: no idea how to use -title: 'usage issue' -labels: issue/usage, issue/not-assign -assignees: 'Icarus9913, iiiceoo' - ---- - -**usage issue** -1. doubts about how to use the software +name: Support +description: Support request or question relating to Spiderpool +labels: ["kind/support"] +assignees: 'ty-dc' +body: + - type: markdown + attributes: + value: | + You are welcome to ask us for help, You can join the [#Spiderpool](https://cloud-native.slack.com/messages/spiderpool) + channel on CNCF Slack by requesting an **[invitation](https://slack.cncf.io/)** from CNCF Slack. Or refer to the + [MAINTAINERS.md](https://github.com/spidernet-io/spiderpool/blob/main/MAINTAINERS.md) to find the email addresses + of all maintainers. Feel free to contact them via email to report any issues or ask questions. + --- + - type: textarea + id: help + attributes: + label: What help do you need？ + placeholder: | + I don't know how to start use Spiderpool... + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f339dac0ba..ddfb2709cf 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,33 @@ ---- -name: Pull request -about: Tell us about your contribution -labels: ["pr/release/none-required"] ---- +## Thanks for contributing! ---- -## Thanks for contributing ! + -Before submitting a pull request, make sure you read about our Contribution notice here: +#### What type of PR is this? + + **What this PR does / why we need it**: **Which issue(s) this PR fixes**: + +Fixes # **Special notes for your reviewer**: - -**make sure your commit is signed off**