Skip to content

Commit

Permalink
docs: update issues template (#895)
Browse files Browse the repository at this point in the history
Signed-off-by: Sertac Ozercan <[email protected]>
  • Loading branch information
sozercan authored Nov 29, 2023
1 parent 7dfba32 commit 55fa69a
Show file tree
Hide file tree
Showing 4 changed files with 78 additions and 45 deletions.
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Bug Report
description: Report a bug in Eraser
title: "[BUG] <title>"
labels:
- "bug"
body:
- type: markdown
attributes:
value: |
Please search to see if an issue already exists for your bug before continuing.
> If you need to report a security issue please see https://github.com/eraser-dev/eraser/security/policy instead.
- type: input
attributes:
label: Version of Eraser
placeholder: Release version (e.g. v1.0.0) or `git describe --dirty` output if built from source
- type: textarea
attributes:
label: Expected Behavior
description: Briefly describe what you expect to happen.
- type: textarea
attributes:
label: Actual Behavior
description: Briefly describe what is actually happening.
- type: textarea
attributes:
label: Steps To Reproduce
description: Detailed steps to reproduce the behavior.
placeholder: |
1. In Kubernetes v1.27.0 ...
2. With this config...
3. Run '...'
4. See error...
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out a bug report!
- type: checkboxes
id: idea
attributes:
label: "Are you willing to submit PRs to contribute to this bug fix?"
description: "This is absolutely not required, but we are happy to guide you in the contribution process especially when you already have a good proposal or understanding of how to implement it. Join us at the `#eraser` channel on the [Kubernetes Slack](https://kubernetes.slack.com/archives/C03Q8KV8YQ4) if you have any questions."
options:
- label: Yes, I am willing to implement it.
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Request
description: Request a new feature or propose an enhancement to Eraser
title: "[REQ] <title>"
labels:
- "enhancement"
body:
- type: markdown
attributes:
value: |
Please search to see if an issue already exists for your request before continuing.
- type: dropdown
attributes:
label: What kind of request is this?
multiple: false
options:
- New feature
- Improvement of existing experience
- Other
- type: textarea
attributes:
label: What is your request or suggestion?
placeholder: |
e.g. I would like Eraser to add this <feature> so that I can use it in my <scenario>.
e.g. When using Eraser the <current behavior> has this <limitation> and it would be better if it has this <improvement>.
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out a request!
- type: checkboxes
id: idea
attributes:
label: "Are you willing to submit PRs to contribute to this feature request?"
description: "This is absolutely not required, but we are happy to guide you in the contribution process especially when you already have a good proposal or understanding of how to implement it. Join us at the `#eraser` channel on the [Kubernetes Slack](https://kubernetes.slack.com/archives/C03Q8KV8YQ4) if you have any questions."
options:
- label: Yes, I am willing to implement it.

0 comments on commit 55fa69a

Please sign in to comment.