Skip to content

Commit

Permalink
feat: Add Github Issue Forms (#206)
Browse files Browse the repository at this point in the history
closes #202

Signed-off-by: Siddharth <[email protected]>
  • Loading branch information
Hard-Coder05 authored Oct 21, 2021
1 parent 39287cd commit f0d98f4
Show file tree
Hide file tree
Showing 4 changed files with 179 additions and 0 deletions.
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: 🐞 Bug report
description: Create a bug report to help us improve Milvus SDK Go
title: "[Bug]: "
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! Please fill the form in English!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
placeholder: |
When I do <X>, <Y> happens and I see the error message attached below:
```...```
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
placeholder: When I do <X>, <Z> should happen instead.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
render: markdown
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
Enter the Environment Details:
render: markdown
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
validations:
required: false
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_improvement.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: 📖 Documentation Improvement
description: Suggest improvements to our documentation
title: "[DOCS]: "
labels: [Documentation]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this documentation improvement request!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue realated to this already exists.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Documentation Link
description: Add a link to the page which needs improvement (if relevant)
validations:
required: false
- type: textarea
attributes:
label: Describe the problem
description: Is the documentation missing? Or is it confusing? Why is it confusing?
validations:
required: false
- type: textarea
attributes:
label: Describe the improvement
description: A clear and concise description of the improvement.
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
validations:
required: false
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Enhancement request
description: As a developer, I want to make an enhancement for Milvus SDK Go
title: "[Enhancement]:"
labels: [kind/enhancement]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to request/suggest an enhancement for Milvus SDK Go! Please fill the form in English!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue related to this already exists.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: What would you like to be added?
description: A concise description of what you're expecting/suggesting.
placeholder: |
I would like to suggest/request a feature that's like...
validations:
required: false
- type: textarea
attributes:
label: Why is this needed?
description: A concise description of the reason/motivation
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about this!
validations:
required: false
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: 🚀 Feature request
description: As a user, I want to request a feature for Milvus SDK Go
title: "[Feature]:"
labels: [kind/feature]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to request a feature for Milvus SDK Go! Please fill the form in English!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue related to this feature request already exists.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe.
description: A concise description of the problem you are facing or the motivetion behind this feature request.
placeholder: |
I faced a problem due to which ...
validations:
required: false
- type: textarea
attributes:
label: Describe the solution you'd like.
description: A concise description of the solution for the issue.
validations:
required: false
- type: textarea
attributes:
label: Describe an alternate solution.
description: Is there any other approack to solve the problem?
validations:
required: false
- type: textarea
attributes:
label: Anything else? (Additional Context)
description: |
Links? References? Anything that will give us more context about this!
validations:
required: false

0 comments on commit f0d98f4

Please sign in to comment.