Skip to content

Commit

Permalink
Add GitHub issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Studio384 committed Aug 18, 2021
1 parent 8aa458d commit 9d67eb3
Show file tree
Hide file tree
Showing 3 changed files with 138 additions and 0 deletions.
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/BugReport.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Bug Report
description: When something has gone wrong.
title: "[Bug] "
labels: [bug, needs confirmation]
assignees:
- studio384
body:
- type: textarea
id: current
attributes:
label: Current behavior
description: Describe the current faulty beharior of Valkyrie.
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
description: Describe the expected beharior of Valkyrie.
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction steps
description: Describe the steps you took to recreate the bug.
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Add screenshots to showcase the bug.
description: If the bug is visual, showcase it with a screenshot or more.
- type: textarea
id: context
attributes:
label: Additional context
description: Add any extra information you'd like to add.

- type: checkboxes
id: implementations
attributes:
label: Which parts of Valkyrie are affected?
options:
- label: Web fonts and CSS
required: false
- label: TypeScript definitions
required: false
- label: SVG icons
required: false
- label: React component
required: false

- type: checkboxes
id: checklist
attributes:
label: Bug report checklist
options:
- label: This bug occures in the latest version of Valkyrie.
required: true
- label: The reproduction is included and is the minimum test case to recreate the faulty behavior.
required: true
- label: I have [searched the issues](https://github.com/optimise-group/valkyrie/issues) for any possible duplications of this bug report.
required: true
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/FeatureRequest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Feature Request
description: Suggest a new idea for Valkyrie.
title: "[Feature] "
labels: [feature]
assignees:
- studio384
body:
- type: textarea
id: why
attributes:
label: What problem or need will this feature solve?
description: Describe why you need this feature.
validations:
required: true
- type: textarea
id: how
attributes:
label: How would this feature work?
description: Describe how this feature reqeust fixes the problem you have.
validations:
required: true
- type: textarea
id: context
attributes:
label: Additional context
description: Add any extra information you'd like to add.

- type: checkboxes
id: checklist
attributes:
label: Check all that apply.
options:
- label: This is a single feature.
required: true
- label: I have [searched the issues](https://github.com/optimise-group/valkyrie/issues) for any possible duplications of this feature request.
required: true
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/IconRequest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Icon Request
description: Request a new icon to be added to the set.
title: "[Icon] Add vi-"
labels: [icon, external]
assignees:
- studio384
body:
- type: input
id: name
attributes:
label: Description
description: Describe the icon you want to see added.
validations:
required: true
- type: textarea
id: reason
attributes:
label: How would it be used?
description: Describe under what situations this icon would be useful.
validations:
required: true
- type: textarea
id: example
attributes:
label: Example icon
description: Add an image below as an example for a similar icon if you have any.

- type: checkboxes
id: checklist
attributes:
label: Check all that apply.
options:
- label: This is a single icon or part of an expected pair (e.g. `eye` and `eye-slashed`).
required: true
- label: I have [searched the issues](https://github.com/optimise-group/valkyrie/issues) for any possible duplications of this icon request.
required: true
- label: An example image is included if available.
required: false

0 comments on commit 9d67eb3

Please sign in to comment.