Skip to content

Commit

Permalink
Merge pull request #14 from printeers/feature/issue-templates
Browse files Browse the repository at this point in the history
Add github issue templates for bug reports and feature requests
  • Loading branch information
DAAAAAAAAAAAAAAAAN authored Jan 7, 2024
2 parents 4737cda + d173cd8 commit 7dd69e6
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Bug report
description: Form to report a bug
labels: ["bug"]
projects: []
body:
- type: markdown
attributes:
value: |
This form is for reporting any situation where a feature is not working as expected.
- type: textarea
id: info
attributes:
label: Description
description: General description
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
1. With this config...
1. Run '...'
1. See error...
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Feature request
description: Form to request a feature
labels: ["enhancement"]
projects: []
body:
- type: markdown
attributes:
value: |
This form is for requesting any functional change of the software. Features can sometimes be for the developers only, such as adding tests or renaming things. In that case, start with 'as a developer, I want ..'.
- type: textarea
id: story
attributes:
label: User story
description: Stick to the suggested form please!
value: |
**As a**
**When**
**I want**
**So that**
validations:
required: true
- type: textarea
id: info
attributes:
label: More info
description: Any additional information that might be useful
validations:
required: false

0 comments on commit 7dd69e6

Please sign in to comment.