Skip to content

Commit

Permalink
[skip ci]
Browse files Browse the repository at this point in the history
improved issue templates
  • Loading branch information
Lyzev committed Jun 15, 2024
1 parent 5365fbc commit 0c8f97a
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 23 deletions.
55 changes: 39 additions & 16 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -1,28 +1,46 @@
name: Bug
description: Report a bug to help us improve Schizoid.
name: Bug Report
description: Help us improve Schizoid by reporting bugs.
title: '[Bug] '
labels: bug
body:

- type: textarea
id: description
attributes:
label: Describe the bug
label: Describe the Bug
description: |
A clear and concise description of what the issue is.
Provide as much information as possible, videos, crash reports, etc.
Provide a clear and concise description of the issue.
Include any relevant information such as error messages, screenshots, or crash reports.
validations:
required: true
- type: textarea
id: reproducing
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: How do you trigger this bug?
render: bash
label: Steps to Reproduce
description: |
Outline the steps to reproduce the bug.
Include detailed instructions so we can replicate the issue.
render: markdown
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: |
Describe what you expected to happen.
validations:
required: true
- type: textarea
id: actual-behavior
attributes:
label: Actual Behavior
description: |
Describe what actually happened.
If applicable, include error messages or logs.
validations:
required: true
- type: dropdown
id: operating-systems
id: operating-system
attributes:
label: Operating System
options:
Expand All @@ -34,13 +52,18 @@ body:
- type: checkboxes
id: prerequisites
attributes:
label: Before submitting a bug report
label: Before Submitting a Bug Report
options:
- label: |
This bug wasn't already reported.
(I have checked every bug report on github)
I have checked that this bug was not already reported.
required: true
- label: |
This is a valid bug.
(I am able to reproduce this on the latest dev build)
I am able to reproduce this bug on the latest development build.
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: |
Add any other context about the problem here.
Include any relevant details such as mods used, configuration settings, etc.
43 changes: 36 additions & 7 deletions .github/ISSUE_TEMPLATE/suggestion.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,51 @@ title: '[Suggestion] '
labels: enhancement
body:
- type: textarea
id: description
id: feature-description
attributes:
label: Describe the feature
description: A clear and concise description of what the feature/change is.
label: Describe the Feature
description: |
Provide a clear and concise description of the feature or change you are suggesting.
Explain what the feature is and why it would be useful.
validations:
required: true
- type: textarea
id: benefits
attributes:
label: Benefits of the Feature
description: |
Describe the benefits of this feature.
How will it improve the user experience or functionality of Schizoid?
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: |
Have you considered any alternative solutions or features?
If so, please describe them and explain why you believe your suggestion is the best option.
validations:
required: false
- type: checkboxes
id: prerequisites
attributes:
label: Before submitting a suggestion
label: Before Submitting a Suggestion
options:
- label: |
This feature doesn't already exist.
I have checked that this feature does not already exist.
(I have checked the source on the **latest build**)
required: true
- label: |
This wasn't already suggested.
(I have checked every suggestion on github)
I have checked that this suggestion was not already made.
(I have reviewed all existing suggestions on GitHub)
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: |
Add any other context or details about the suggestion here.
Include any relevant information such as related features, mockups, or use cases.
validations:
required: false

0 comments on commit 0c8f97a

Please sign in to comment.