Skip to content

Commit

Permalink
feat: upgrades to issue templates (#217)
Browse files Browse the repository at this point in the history
Co-authored-by: Khuda Dad Nomani <[email protected]>%0ACo-authored-by: Alejandra Quetzalli <[email protected]>%0ACo-authored-by: Lukasz Gornicki <[email protected]>
  • Loading branch information
tamalCodes and derberg authored Feb 21, 2024
1 parent c5239ca commit a10768b
Show file tree
Hide file tree
Showing 4 changed files with 153 additions and 36 deletions.
18 changes: 0 additions & 18 deletions .github/ISSUE_TEMPLATE/bug.md

This file was deleted.

83 changes: 83 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
name: 🐛 Bug Report
description: Report bugs to fix and improve.
title: "[BUG] <description>"
labels: ["bug"]


body:
- type: textarea
id: description
attributes:
label: Describe the bug.
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true


- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Please add screenshots/video of the bug you faced.
validations:
required: true

- type: textarea
id: reproduce
attributes:
label: How to Reproduce
description: Attach all steps/share a github gist that can help anyone reproduce the bug.
value: |
1. I first did this
2. I then did this
3. And so on . . .
validations:
required: true

- type: dropdown
id: browser
attributes:
label: "🥦 Browser"
description: "What browser are you using?"
options:
- Google Chrome
- Brave
- Microsoft Edge
- Mozilla Firefox
- Safari
- Opera
- Other
validations:
required: optional

- type: checkboxes
id: no-duplicate-issues
attributes:
label: "👀 Have you checked for similar open issues?"
options:
- label: "I checked and didn't find similar issue"
required: true

- type: checkboxes
id: read-code-of-conduct
attributes:
label: "🏢 Have you read the Contributing Guidelines?"
options:
- label: "I have read the [Contributing Guidelines](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md)"
required: true

- type: dropdown
attributes:
label: Are you willing to work on this issue ?
description: This is absolutely not required, but we are happy to guide you in the contribution process.
options:
- "Yes I am willing to submit a PR!"
- "No, someone else can work on it"
18 changes: 0 additions & 18 deletions .github/ISSUE_TEMPLATE/enhancement.md

This file was deleted.

70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: 💡 Feature Request
description: Suggest a new idea/feature
title: "[FEATURE] <description>"
labels: ["enhancement"]

body:
- type: textarea
id: need_improvement
attributes:
label: Why do we need this improvement?
validations:
required: true

- type: textarea
id: change
attributes:
label: How will this change help?
validations:
required: true

- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Please add screenshots if applicable
validations:
required: false


- type: textarea
id: implemented
attributes:
label: How could it be implemented/designed?
validations:
required: true

- type: dropdown
id: breakingchange
attributes:
label: "🚧 Breaking changes"
description: "Will this be a breaking change?"
options:
- "Yes"
- "No"
validations:
required: true

- type: checkboxes
id: no-duplicate-issues
attributes:
label: "👀 Have you checked for similar open issues?"
options:
- label: "I checked and didn't find a similar issue"
required: true

- type: checkboxes
id: read-code-of-conduct
attributes:
label: "🏢 Have you read the Contributing Guidelines?"
options:
- label: "I have read the [Contributing Guidelines](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md)"
required: true

- type: dropdown
attributes:
label: Are you willing to work on this issue?
description: This is absolutely not required, but we are happy to guide you in the contribution process.
options:
- "Yes I am willing to submit a PR!"
- "No, someone else can work on it."

0 comments on commit a10768b

Please sign in to comment.