-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #14 from printeers/feature/issue-templates
Add github issue templates for bug reports and feature requests
- Loading branch information
Showing
3 changed files
with
62 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
blank_issues_enabled: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |