aboutsummaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
authorInventhrice <45127310+Inventhrice@users.noreply.github.com>2024-10-19 09:21:43 -0400
committerGitHub <noreply@github.com>2024-10-19 14:21:43 +0100
commite55362ec57f2a20ed096f971e769269b6f8211c8 (patch)
tree29983c77a7f9bb0550cbf144f00c91b619fdbdb2 /.github
parent6977ba76e1454c8fbf8740b8eab2ea49651375ed (diff)
downloadkarakeep-e55362ec57f2a20ed096f971e769269b6f8211c8.tar.zst
chore: Adding issue templates (#546)
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yml61
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.yml46
2 files changed, 107 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 00000000..bc9de30d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,61 @@
+name: Bug Report
+description: Create a report to help us fix bugs & issues in existing supported functionality
+labels: [":bug: Bug"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to fill out a bug report!
+ Please note that this form is for reporting bugs in existing supported functionality.
+
+ If you are reporting something that's not an issue in functionality we've previously supported and/or is simply something different to your expectations, then it may be more appropriate to raise via a feature or support request instead.
+ - type: textarea
+ id: description
+ attributes:
+ label: Describe the Bug
+ description: Provide a clear and concise description of what the bug is.
+ validations:
+ required: true
+ - type: textarea
+ id: reproduction
+ attributes:
+ label: Steps to Reproduce
+ description: Detail the steps that would replicate this issue.
+ placeholder: |
+ 1. Go to '...'
+ 2. Click on '....'
+ 3. Scroll down to '....'
+ 4. See error
+ validations:
+ required: true
+ - type: textarea
+ id: expected
+ attributes:
+ label: Expected Behaviour
+ description: Provide clear and concise description of what you expected to happen.
+ validations:
+ required: true
+ - type: textarea
+ id: context
+ attributes:
+ label: Screenshots or Additional Context
+ description: Provide any additional context and screenshots here to help us solve this issue.
+ validations:
+ required: false
+ - type: input
+ id: devicedetails
+ attributes:
+ label: Device Details
+ description: |
+ If this is an issue that occurs when using the Hoarder interface, please provide details of the device/browser used which presents the reported issue.
+ placeholder: (eg. Firefox 97 (64-bit) on Windows 11)
+ validations:
+ required: false
+ - type: input
+ id: bsversion
+ attributes:
+ label: Exact Hoarder Version
+ description: This can be found in the bottom left of the page (eg Hoarder v0.18.0)
+ placeholder: (eg. v0.18.0)
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 00000000..a5a90021
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,46 @@
+name: Feature Request
+description: Request a new feature or idea to be added to Hoarder
+labels: [":hammer: Feature Request"]
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: Describe the feature you'd like
+ description: Provide a clear description of the feature you'd like implemented in Hoarder
+ validations:
+ required: true
+ - type: textarea
+ id: benefits
+ attributes:
+ label: Describe the benefits this would bring to existing Hoarder users
+ description: |
+ Explain the measurable benefits this feature would achieve for existing Hoarder users.
+ These benefits should details outcomes in terms of what this request solves/achieves, and should not be specific to implementation.
+ This helps us understand the core desired goal so that a variety of potential implementations could be explored.
+ This field is important. Lack if input here may lead to early issue closure.
+ validations:
+ required: true
+ - type: textarea
+ id: already_achieved
+ attributes:
+ label: Can the goal of this request already be achieved via other means?
+ description: |
+ Yes/No. If yes, please describe how the requested approach fits in with the existing method.
+ validations:
+ required: true
+ - type: checkboxes
+ id: confirm-search
+ attributes:
+ label: Have you searched for an existing open/closed issue?
+ description: |
+ To help us keep these issues under control, please ensure you have first [searched our issue list](https://github.com/hoarder-app/Hoarder/issues?q=is%3Aissue) for any existing issues that cover the fundamental benefit/goal of your request.
+ options:
+ - label: I have searched for existing issues and none cover my fundamental request
+ required: true
+ - type: textarea
+ id: context
+ attributes:
+ label: Additional context
+ description: Add any other context or screenshots about the feature request here.
+ validations:
+ required: false