-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create pull request and issue templates (#85)
Signed-off-by: David Kornel <[email protected]>
- Loading branch information
Showing
5 changed files
with
138 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
name: Bug report | ||
description: Create a report to help us improve | ||
title: '[Bug]: ' | ||
labels: ['bug', 'needs-triage'] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: _Please use this only for bug reports. For questions or when you need help, you can use the [GitHub Discussions](https://github.com/skodjob/test-frame/discussions)._ | ||
- type: textarea | ||
attributes: | ||
label: Bug Description | ||
description: Describe the bug | ||
placeholder: A clear and concise description of what the bug is. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Expected behavior | ||
description: What is the behavior you expected to see? Please describe. | ||
placeholder: A clear and concise description of what you expected to happen. | ||
validations: | ||
required: false | ||
- type: input | ||
id: test-frame-version | ||
attributes: | ||
label: TEST-FRAME version | ||
description: Test-Frame version where the bug occurred | ||
placeholder: e.g. main, 0.1.0 | ||
validations: | ||
required: true | ||
- type: input | ||
id: kubernetes-version | ||
attributes: | ||
label: Kubernetes version | ||
description: Kubernetes version where the bug occurred | ||
placeholder: e.g. Kubernetes 1.25, OpenShift 4.11 | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Logs | ||
description: All relevant configuration and log files | ||
placeholder: | | ||
Attach or copy and paste the relevant logs. | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Additional context | ||
description: Any additional context related to the problem | ||
placeholder: 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 |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: Questions and Discussions | ||
url: https://github.com/skodjob/test-frame/discussions | ||
about: Please ask and discuss questions here. |
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 |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Documentation | ||
description: Report a bug or suggest an idea for our documentation | ||
title: '[Docs]: ' | ||
labels: ['documentation', 'needs-triage'] | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: Suggestion / Problem | ||
description: Suggestion / Problem | ||
placeholder: Describe your problem or suggestion | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Documentation Link | ||
description: Link(s) to the relevant documentation | ||
placeholder: Provide link(s) to the documentation where the bug / suggestion should be applied | ||
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 |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
name: Feature request | ||
description: Suggest an idea for this project | ||
title: '[Enhancement]: ' | ||
labels: ['enhancement', 'needs-triage'] | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: Related problem | ||
description: Is your feature request related to a problem? Please describe. | ||
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when ... | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Suggested solution | ||
description: Describe the solution you'd like | ||
placeholder: A clear and concise description of what you want to happen. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Alternatives | ||
description: Describe alternatives you've considered | ||
placeholder: A clear and concise description of any alternative solutions or features you've considered. | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Additional context | ||
description: Additional context | ||
placeholder: Add any other context or screenshots about the feature request 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 |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Pull Request Template | ||
|
||
## Description | ||
|
||
_Please include a summary of the changes and the related issue. Please 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) | ||
* Documentation update | ||
|
||
## 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/integration tests pass locally with my changes |