.github/ISSUE_TEMPLATE/bug_report.yml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

name: Bug Report
description: Create a report to help us fix bugs & issues in existing supported functionality
labels: ["bug", "status/untriaged"]
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 Karakeep 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 Karakeep Version
      description: This can be found in the bottom left of the page (e.g. Karakeep v0.18.0)
      placeholder: (eg. v0.18.0)
    validations:
      required: true

  - type: checkboxes
    id: confirm-troubleshooting
    attributes:
      label: Have you checked the troubleshooting guide?
      description: |
        We have a troubleshooting guide that you can find [here](https://docs.karakeep.app/next/troubleshooting). Please check it out as you might find a solution to your problem.
      options:
        - label: I have checked the troubleshooting guide and I haven't found a solution to my problem
          required: true