Skip to content

Commit

Permalink
Added issue templates (#72)
Browse files Browse the repository at this point in the history
  • Loading branch information
xBlaz3kx authored Jan 18, 2025
1 parent ed6e932 commit 0f9573e
Show file tree
Hide file tree
Showing 3 changed files with 125 additions and 0 deletions.
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: 'πŸ› Bug Report'
description: 'Submit a bug report'
title: 'πŸ› Bug: '
labels: [ 'type: bug' ]
body:
- type: textarea
id: description
validations:
required: true
attributes:
label: 'πŸ“œ Description'
description: 'A clear and concise description of what the bug is.'
placeholder: 'It bugs out when ...'
- type: textarea
id: steps-to-reproduce
validations:
required: true
attributes:
label: 'πŸ‘Ÿ Reproduction steps'
description: 'How do you trigger this bug? Please walk us through it step by step.'
placeholder: "1. Install the package\n2. Run the command ..."
- type: textarea
id: expected-behavior
validations:
required: true
attributes:
label: 'πŸ‘ Expected behavior'
description: 'What did you think should happen?'
placeholder: 'It should ...'
- type: textarea
id: actual-behavior
validations:
required: true
attributes:
label: 'πŸ‘Ž Actual Behavior'
description: 'What did actually happen? Add screenshots, if applicable.'
placeholder: 'It actually ...'
- type: input
id: release-version
validations:
required: false
attributes:
label: release version
description: Mention the release version of the software you are using.
placeholder: v1.2.3
- type: textarea
id: additional-context
validations:
required: false
attributes:
label: 'πŸ“ƒ Provide any additional context for the Bug.'
description: 'Add any other context about the problem here.'
placeholder: 'It actually ...'
- type: checkboxes
id: no-duplicate-issues
attributes:
label: 'πŸ‘€ Have you spent some time to check if this bug has been found before?'
options:
- label: "I checked and didn't find a similar issue"
required: true
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: πŸš€ Feature
description: 'Submit a proposal for a new feature'
title: 'πŸš€ Feature: '
labels: [ feature ]
body:
- type: textarea
id: feature-description
validations:
required: true
attributes:
label: 'πŸ”– Feature description'
description: 'A clear and concise description of what the feature is.'
placeholder: 'You should add ...'
- type: textarea
id: pitch
validations:
required: true
attributes:
label: '🎀 Why is this feature needed ?'
description: 'Please explain why this feature should be implemented and how it would be used. Add examples, if
applicable.'
placeholder: 'In my use-case, ...'
- type: textarea
id: solution
validations:
required: true
attributes:
label: '✌️ How do you aim to achieve this?'
description: 'A clear and concise description of what you want to happen.'
placeholder: 'I want this feature to, ...'
- type: textarea
id: alternative
validations:
required: false
attributes:
label: 'πŸ”„οΈ Additional Information'
description: "A clear and concise description of any alternative solutions or additional solutions you've considered."
placeholder: 'I tried, ...'
- type: checkboxes
id: no-duplicate-issues
attributes:
label: 'πŸ‘€ Have you spent some time to check if this feature request has been raised before?'
options:
- label: "I checked and didn't find similar issue"
required: true
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/general_question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: '❔ Question'
description: 'Submit a general question to the community.'
title: '❔ Question: '
labels: [ 'type: question' ]
body:
- type: textarea
id: description
validations:
required: true
attributes:
label: '❔ What is your question?'
description: 'The stage is yours. Ask away! Try to provide as much context as possible.'
placeholder: 'What is the best way to ...'
- type: checkboxes
id: no-duplicate-issues
attributes:
label: 'πŸ‘€ Have you spent some time to check if this question has been asked before?'
options:
- label: "I checked and didn't find a similar issue"
required: true

0 comments on commit 0f9573e

Please sign in to comment.