Skip to content

Commit

Permalink
Improve issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
blaisewf committed Sep 8, 2024
1 parent 53ff2cb commit f1425b8
Show file tree
Hide file tree
Showing 4 changed files with 125 additions and 201 deletions.
32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

88 changes: 88 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
name: Bug report
description: Report a problem you encountered
title: "[Bug]: "
labels: ["bug"]
body:
- type: input
id: project
attributes:
label: Project Version
description: Which project versions are affected?
placeholder: "3.2.1, 3.2.2, 3.2.3"
validations:
required: true
- type: input
id: platform
attributes:
label: Platform and OS Version
description: Which platforms or operating systems are affected?
placeholder: "Windows 10 64-bit, Firefox 123"
validations:
required: true
- type: input
id: devices
attributes:
label: Affected Devices
description: Does this only occur on specific devices?
placeholder: "All, iPhone X, iPhone SE, iPad Air, MacBook Pro"
validations:
required: true
- type: input
id: existing-issues
attributes:
label: Existing Issues
description: Are there any similar existing issues?
placeholder: "#69"
validations:
required: false
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Clearly and concisely describe the bug.
placeholder: Tell us what happened.
validations:
required: true
- type: textarea
id: repro-steps
attributes:
label: Steps to reproduce
value: |
1.
2.
3.
...
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: What should have happened?
placeholder: What did you expect to happen?
validations:
required: true
- type: textarea
id: attachments
attributes:
label: Attachments
description: Please include code snippets, stack traces, or compiler errors.
placeholder: Paste code snippets, stack traces, and compiler errors here
validations:
required: false
- type: textarea
id: screenshots
attributes:
label: Screenshots or Videos
description: Add screenshots, gifs, or videos to help explain your problem.
placeholder: Upload screenshots, gifs, and videos here
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional Information
description: Add any other useful information about the problem here.
placeholder: Is there any additional helpful information you can share?
validations:
required: false
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature request
description: Suggest an idea for this project
title: "[Feature]: "
labels: ["feature request", "enhancement", "feature"]
body:
- type: textarea
id: description
attributes:
label: Description
description: Clearly and concisely describe what you would like to change, add, or implement.
placeholder: Tell us your idea.
validations:
required: true
- type: textarea
id: problem
attributes:
label: Problem
description: Is your feature request related to a problem?
placeholder: What problem will this solve?
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: How should this be solved?
placeholder: How do you think this should be implemented?
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: Are there other possible approaches?
placeholder: Can you think of any other options?
validations:
required: true
169 changes: 0 additions & 169 deletions .github/workflows/issue_helper.yml

This file was deleted.

0 comments on commit f1425b8

Please sign in to comment.