Skip to content

Commit

Permalink
Merge pull request #105 from SukiCZ/feat/issue_template
Browse files Browse the repository at this point in the history
Init Github Issue Template. Fixes: #104
  • Loading branch information
SukiCZ authored Oct 20, 2024
2 parents dde6051 + 6299ac5 commit 8c5c58e
Show file tree
Hide file tree
Showing 2 changed files with 136 additions and 0 deletions.
80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
name: Bug report
description: Report a bug to help us improve
title: "[BUG] "
labels:
- bug

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: input
id: title
attributes:
label: Bug Title
description: A clear and concise title for the bug.
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: |
Please provide a step-by-step list of actions that can be used to reproduce the bug.
Example:
1. Import '...'
2. Initialize '...'
3. Call a function with parameters '...'
4. See error
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual Behavior
description: A clear and concise description of what actually happened.
validations:
required: true

- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem.

- type: input
id: environment
attributes:
label: Environment
description: |
Please provide details about your environment:
- OS: [e.g. Windows, MacOS, Linux]
- Version of application: [e.g. 1.1.10]
validations:
required: true

- type: textarea
id: additional
attributes:
label: Additional Context
description: Add any other context about the problem here.
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Feature request
description: Suggest a new feature or enhancement
title: "[FEATURE] "
labels:
- enhancement

body:
- type: markdown
attributes:
value: |
Thanks for suggesting a feature to improve our project!
- type: input
id: title
attributes:
label: Feature Title
description: A clear and concise title for the feature.
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of what the feature is and how it would work.
validations:
required: true

- type: textarea
id: benefits
attributes:
label: Benefits
description: |
Please describe the benefits of this feature.
Example:
- Improves user experience by...
- Adds new functionality for...
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives
description: |
Describe any alternative solutions or features you've considered.
Example:
- Instead of this feature, we could...
validations:
required: true

- type: textarea
id: additional
attributes:
label: Additional Context
description: Add any other context or screenshots about the feature request here.

0 comments on commit 8c5c58e

Please sign in to comment.