Skip to content

Commit

Permalink
Add issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
BWibo committed Jun 6, 2023
1 parent e8f72ba commit 79cb24f
Show file tree
Hide file tree
Showing 2 changed files with 138 additions and 0 deletions.
96 changes: 96 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
name: " 🐞 Bug report"
description: File a bug report, security issue, documentation issue, ...
title: "Type here what this issue is about..."
labels: ["state: triage", "type: bug"]
assignees:
- BWibo
body:
- type: markdown
attributes:
value: |-
*Thanks for taking the time to fill out this bug report!*
Before you begin, please search the issues of this repo if this problem has already been solved!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: |-
Describe the problem you are facing. Also tell us, what you did expect to happen?
If applicable, add a screenshot (Drag & drop, see below).
placeholder: Tell us what you see!
value: "A bug happened! I expected this to be like ..."
validations:
required: true

- type: textarea
id: how-to-reproduce
attributes:
label: Steps to reproduce
description: Tell us step-by-step how the bug can be reproduced!
placeholder: |
1. Deploy the Helm chart
2. See the logs using `kubectl get events`
3. ...
validations:
required: true

- type: textarea
id: config
attributes:
label: Configuration
description: |-
Please copy and paste you configuration YAML-file (`values.yml` for ``helm``) here. **Make sure to strip sensitive information.**
This will be automatically formatted into code, so no need for backticks.
render: YAML
validations:
required: true

- type: textarea
id: versions
attributes:
label: Versions and environment
description: |-
Tell us what software versions you are using?
If helpful, add information on your environment, e.g. relevant environment variables.
placeholder: |
- Operating system: Windows 10 `x.x.x`
- Version of the helm chart in this repo: `x.x.x`
- `helm` version: `x.x.x`
- `kubernetes` version: `x.x.x`
- other relevant software/tool/.... version: `x.x.x`
value: |
#### Version information
- tool/software/...: `x.x.x`
#### Environment information
- VARIABLE_NAME: `values`
validations:
required: true

- type: dropdown
id: browsers
attributes:
label: If applicable, what browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge

- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output (Browser logs, console logs, ...).
This will be automatically formatted into code, so no need for backticks.
render: Shell

- type: textarea
id: comments
attributes:
label: Additional information and comments
description: |
Please add any additional information or comment you find relevant regarding this issue here!
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: "🚀 Feature request"
description: Suggest a new feature, improvement, idea, ...
title: "Type here what this is about..."
labels: ["state: triage", "type: feature"]
assignees:
- BWibo
body:
- type: markdown
attributes:
value: |-
**Thanks for taking the time to submit this feature request!**
- type: textarea
id: description
attributes:
label: Feature description
description: |-
Please describe the feature you are missing? What problem should be solved?
If applicable, add a screenshot (Drag & drop, see below).
placeholder: "I'm missing something to do stuff..."
validations:
required: true

- type: textarea
id: solution
attributes:
label: Suggested solution
description: |-
If you know how to get this done, you can let us know here.
If applicable, add a screenshot (Drag & drop, see below).
placeholder: "I'm missing something to do stuff..."
validations:
required: false

- type: textarea
id: code-snippets
attributes:
label: Code snippets
description: |-
If you have a helpful code snippet to get this done, please add it here.
This will be automatically formatted into code, so no need for backticks.
render: Shell

0 comments on commit 79cb24f

Please sign in to comment.