summaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE/bug_report.yaml
blob: e062068cdd284c9cc5d9e3248d01bfe50b197a2d (plain)
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
name: "🐛 Bug Report"
description: "Submit a bug report to help us improve nvf"
title: "<short description of the bug>"
labels: [bug]
body:
  - type: checkboxes
    attributes:
      label: I have confirmed that this is a bug related to nvf
      description: >-
        If you are unsure whether this is a bug, a packaging issue, or user error that is *not*
        stemming from nvf, please consider creating a [discussion](https://github.com/notashelf/nvf/discussions)
        post instead. Invalid bug reports will be closed without an explanation.
      options:
        - required: true
          label: >-
            This is a bug, and not an user error or a support request. I understand that my issue
            will be closed if it is not a bug in nvf.
        - required: true
          label: >-
            I have checked the [issues tab](https://github.com/notashelf/nvf/issues?q=is%3Aissue)
            and confirmed that my issue has not yet been reported. I understand that my issue will
            be closed if it is a duplicate.

  - type: textarea
    attributes:
      label: Description
      placeholder: "Describe the issue here..."
      description: >-
        Describe the issue in detail, with steps you have taken included. If applicable, please include
        a minimal reproducible example, relevant Nix logs, comparisons with alternative commands and
        screenshots. Do note that **logs** are preferred over screenshots.
    validations:
      required: true

  - type: dropdown
    attributes:
      label: Installation Method
      description: "How was nvf installed?"
      options:
        - NixOS Module (`nixosModules.default`)
        - Home Manager Module (`homeManagerModules.default`)
        - Standalone (flake outputs, `nix profile install`, etc.)
        - Other
    validations:
      required: true

  - type: textarea
    attributes:
      label: Installation Method (Other)
      description: "If you have selected 'Other' in the previous section, please describe your installation method"
      placeholder: >-
        I installed nvf from...

  - type: textarea
    attributes:
      label: nvf Version
      description: "Which version of nvf are you using? If added as a flake input, write 'main'"
      placeholder: >-
        For example, 26.07 if consuming nvf from a tagged release.
    validations:
      required: true

  - type: textarea
    id: steps-to-reproduce
    attributes:
      label: Reproduction steps
      description: "How do you trigger this bug? Please walk us through the problem, step by step"
      placeholder: >-
        1. Do this
        2. Do that
        3. Observe
    validations:
      required: true

  - type: textarea
    id: expected-behavior
    attributes:
      label: Expected behavior
      description: "What did you think would or should happen?"
      placeholder: "..."
    validations:
      required: true

  - type: textarea
    id: actual-behavior
    attributes:
      label: Actual Behavior
      description: "What actually happen?"
      placeholder: "..."
    validations:
      required: true

  - type: textarea
    attributes:
      label: System Information
      description: "Output of `nix-info --markdown`"
      render: bash
      placeholder: |-
        '[user@system:~]$ nix-shell -p nix-info --run "nix-info --markdown"
        - system:
        - host os:
        - multi-user?:
        - sandbox:
        - version:
        - nixpkgs:
    validations:
      required: true

  - type: textarea
    id: logs
    attributes:
      render: bash
      label: "Relevant log output"
      description: >-
        Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.

        > [!TIP]
        > You can get your nvf configuration with `nvf-print-config` and attach it by using a service like termbin.com
    validations:
      required: true