Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add github issue templates for bug reports and feature requests #14

Merged
merged 2 commits into from
Jan 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading