Skip to content

Commit

Permalink
Merge pull request #5 from mertcandav/add-issue-templates
Browse files Browse the repository at this point in the history
maintenance: add issue templates
  • Loading branch information
lareii authored Aug 24, 2024
2 parents 527e182 + 2db5686 commit 2065c4a
Show file tree
Hide file tree
Showing 4 changed files with 88 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: "Bug report"
description: "Create a report to help us improve"
title: "[BUG] <description>"
labels: [bug]
body:
- type: textarea
id: description
attributes:
label: Description
description: Provide a general summary of the bug you found
validations:
required: true
- type: textarea
id: expectedbhv
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
id: currentbhv
attributes:
label: Current behavior
description: Tell us what happens instead
validations:
required: false
- type: textarea
id: extrainfo
attributes:
label: Additional information
description: Is there anything else we should know about this bug?
validations:
required: true
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: false
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/other.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Other
description: Use this for any other issues. Do NOT create blank issues
title: "[OTHER]"
labels: ["awaiting triage"]
body:
- type: textarea
id: issuedescription
attributes:
label: What would you like to share?
description: Provide a clear and concise explanation of your issue.
validations:
required: true
- type: textarea
id: extrainfo
attributes:
label: Additional information
description: Is there anything else we should know about this issue?
validations:
required: false
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/proposal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Proposal
description: Suggest features, propose improvements, discuss new ideas.
title: "[PROPOSAL] <description>"
labels: [proposal]
body:
- type: textarea
id: description
attributes:
label: Detailed description
description: Provide a detailed description of the change or addition you are proposing.
validations:
required: true
- type: textarea
id: context
attributes:
label: Context
description: |
Why is this change important to you? How would you use it?
How can it benefit other users?
validations:
required: true
- type: textarea
id: possibleimpl
attributes:
label: Possible implementation
description: Not obligatory, but suggest an idea for implementing addition or change.
validations:
required: false
- type: textarea
id: extrainformation
attributes:
label: Additional information
description: Is there anything else we should know about this feature?
validations:
required: false

0 comments on commit 2065c4a

Please sign in to comment.