forked from spidernet-io/spiderpool
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use github forms for issue templates
- Loading branch information
Showing
6 changed files
with
223 additions
and
121 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: <test-name>. | ||
|
|
||
| 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? | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: <https://spidernet-io.github.io/spiderpool/latest/develop/contributing/>--> | ||
|
|
||
| Before submitting a pull request, make sure you read about our Contribution notice here: <https://spidernet-io.github.io/spiderpool/latest/develop/contributing/> | ||
| #### What type of PR is this? | ||
|
|
||
| <!-- | ||
| Add one of the following kinds: | ||
| Required labels: | ||
| - release/none | ||
| - release/bug | ||
| - release/feature | ||
| Optional labels: | ||
| - kind/bug | ||
| - kind/feature | ||
| - kind/ci-bug | ||
| - kind/doc | ||
| --> | ||
|
|
||
| **What this PR does / why we need it**: | ||
|
|
||
| **Which issue(s) this PR fixes**: | ||
| <!-- | ||
| *Automatically closes linked issue when PR is merged. | ||
| Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`. | ||
| --> | ||
| Fixes # | ||
|
|
||
| **Special notes for your reviewer**: | ||
|
|
||
| **make sure your commit is signed off** |