Skip to content

Commit

Permalink
add basic issue templates (#164)
Browse files Browse the repository at this point in the history
* add basic issue templates

* adjust wording

* Update bug_report.yml
  • Loading branch information
Roma36 authored Sep 20, 2023
1 parent 6c93ae9 commit 6e26de1
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 0 deletions.
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: "🐛 Bug Report"
description: Create a new ticket for a bug.
title: "🐛 [BUG] - <title>"
labels: [
"bug"
]
body:
- type: textarea
id: description
attributes:
label: "Description"
description: Please enter an explicit description of your issue
placeholder: Short and explicit description of your incident...
validations:
required: true
- type: textarea
id: reprod
attributes:
label: "Reproduction steps"
description: Please enter an explicit description of your issue
value: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
render: bash
validations:
required: true
- type: textarea
id: screenshot
attributes:
label: "Screenshots"
description: If applicable, add screenshots to help explain your problem.
value: |
![DESCRIPTION](LINK.png)
render: bash
validations:
required: false
- type: textarea
id: logs
attributes:
label: "Logs"
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: bash
validations:
required: false
- type: dropdown
id: browsers
attributes:
label: "Browsers"
description: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- Opera
validations:
required: false
- type: dropdown
id: os
attributes:
label: "OS"
description: On which operating system this issue occurs?
multiple: true
options:
- Windows
- Linux
- Mac
validations:
required: false
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/improvement_idea.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: "💡 Improvement idea"
description: Create a new ticket for improvement
title: "💡 [IMPROVEMENT] - <title>"
labels: [
"improvement"
]
body:
- type: textarea
id: summary
attributes:
label: "Summary"
description: Provide a brief explanation of the improvement
placeholder: Describe in a few lines your idea
validations:
required: true
- type: textarea
id: basic_example
attributes:
label: "Basic Example"
description: Indicate here some basic examples of your idea.
placeholder: A few specific words about your idea.
validations:
required: true
- type: textarea
id: drawbacks
attributes:
label: "Drawbacks"
description: What are the drawbacks/impacts of your idea ?
placeholder: Identify the drawbacks and impacts while being neutral on your idea
validations:
required: true
- type: textarea
id: unresolved_question
attributes:
label: "Unresolved questions"
description: What questions still remain unresolved ?
placeholder: Identify any unresolved issues.
validations:
required: false

0 comments on commit 6e26de1

Please sign in to comment.