feat: add issue templates #4
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| name: Bug Report | ||
| description: Let us know about a bug | ||
| labels: | ||
| - bug | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: What is the issue? | ||
| description: | | ||
| Describe the bug here. Please provide as much information as possible. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: expected | ||
| attributes: | ||
| label: What is the expected behavior? | ||
| description: | | ||
| Please describe the expected behavior here. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: repro | ||
| attributes: | ||
| label: How can we reproduce the bug? | ||
| description: | | ||
| Include repro steps and associated relevant information here. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: notes | ||
| attributes: | ||
| label: notes | ||
| description: | | ||
| Any additional information should be included here. | ||
| validations: | ||
| required: false |
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| name: Feature Request | ||
| description: Suggest a new feature or enhancement | ||
| labels: | ||
| - enhancement | ||
|
There was a problem hiding this comment. I decided to simply use the default labels for now; we can consider creating and assigning custom ones in the future 👍 |
||
| body: | ||
| - type: textarea | ||
| id: what | ||
| attributes: | ||
| label: What should this feature do? | ||
| description: | | ||
| Describe the feature or enhancement (what it should do, etc.) here. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: why | ||
| attributes: | ||
| label: Why is it needed? | ||
| description: | | ||
| Include information about why the feature should be implemented here. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: how | ||
| attributes: | ||
| label: How should it be implemented? | ||
| description: | | ||
| If known, any suggestions / ideas on how the feature could implemented. | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| id: notes | ||
| attributes: | ||
| label: Notes | ||
| description: | | ||
| Any additional information should be included here. | ||
| validations: | ||
| required: false | ||
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I used Kubernetes' issue templates as a reference, while trying to preserve our "what, why, how" format.