pyrox.dev
1name: "Bug report (NixOS module)"
2description: "Create a bug report against a NixOS Module."
3title: "nixos/MODULENAME: BUG TITLE"
4labels: ["0.kind: bug", "6.topic: nixos"]
5body:
6 - type: "markdown"
7 attributes:
8 value: |
9 <p align="center">
10 <a href="https://nixos.org">
11 <picture>
12 <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/NixOS/nixos-artwork/refs/heads/master/logo/nixos.svg">
13 <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/NixOS/nixos-artwork/refs/heads/master/logo/nixos-white.svg">
14 <img src="https://raw.githubusercontent.com/NixOS/nixos-artwork/refs/heads/master/logo/nixos.svg" width="400px" alt="NixOS logo">
15 </picture>
16 </a>
17 </p>
18
19 Welcome to Nixpkgs. Please replace the **`nixos/MODULENAME: BUG TITLE`** template above with the correct module name (As seen in the [NixOS Option Search](https://search.nixos.org/options)) and a short title summarising what the bug entails.
20
21 > [!TIP]
22 > For instance, if you were filing a bug against the [`systemd-boot`](https://search.nixos.org/options?channel=unstable&show=boot.loader.systemd-boot.enable&from=0&size=1) module about it failing to install [`memtest86`](https://search.nixos.org/options?channel=unstable&show=boot.loader.systemd-boot.memtest86.enable&from=0&size=1), your title would be as follows:
23 > ```
24 > nixos/systemd-boot: fails to install memtest86
25 > ```
26
27 ---
28 - type: "dropdown"
29 id: "version"
30 attributes:
31 label: "Nixpkgs version"
32 description: |
33 What version of Nixpkgs are you using?
34
35 If you are using an older version, please update to the latest stable version and check if the issue persists before continuing this bug report.
36 options:
37 - "Please select a version."
38 - "- Unstable (25.11)"
39 - "- Stable (25.05)"
40 default: 0
41 validations:
42 required: true
43 - type: "textarea"
44 id: "description"
45 attributes:
46 label: "Describe the bug"
47 description: "Please include a clear and concise description of what the issue is."
48 validations:
49 required: true
50 - type: "textarea"
51 id: "how-to-reproduce"
52 attributes:
53 label: "Steps to reproduce"
54 description: "Please include a step-by-step guide for reproducing this issue. Consider writing in concise, numbered bullet points to ensure that Nixpkgs developers can retrace your steps."
55 validations:
56 required: true
57 - type: "input"
58 id: "expected-behaviour"
59 attributes:
60 label: "Expected behaviour"
61 description: "Please write a concise description of what was supposed to happen."
62 validations:
63 required: true
64 - type: "textarea"
65 id: "screenshots"
66 attributes:
67 label: "Screenshots"
68 description: |
69 If applicable, add screenshots to help explain your problem.
70 If you need help uploading images to GitHub, please review the [relevant documentation](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#uploading-assets).
71 validations:
72 required: false
73 - type: "textarea"
74 id: "logs"
75 attributes:
76 label: "Relevant log output"
77 description: |
78 If applicable, copy and paste any relevant log output.
79 This will be automatically formatted into code, so no need for backticks.
80 render: "console"
81 validations:
82 required: false
83 - type: "textarea"
84 id: "additional-context"
85 attributes:
86 label: "Additional context"
87 description: "Add any other context about the problem here."
88 validations:
89 required: false
90 - type: "textarea"
91 id: "metadata"
92 attributes:
93 label: "System metadata"
94 description: "Please run `nix-shell -p nix-info --run \"nix-info -m\"` on a terminal and paste the output of that command here."
95 validations:
96 required: true
97 - type: "textarea"
98 id: "maintainers"
99 attributes:
100 label: "Notify maintainers"
101 description: |
102 Please mention the people who are in the `meta.maintainers` list of the offending module. This is done by prefixing the person's username with an '@' character. You can quickly go to the source code of a module by searching for it on the [NixOS Option Search](https://search.nixos.org/options) and clicking the "Declared in..." button.
103
104 Please note that the maintainer attribute name does not always match the maintainer's GitHub username. If that occurs, try looking in [`maintainers/maintainer-list.nix`](https://github.com/NixOS/nixpkgs/blob/master/maintainers/maintainer-list.nix) for the maintainer attribute name, and checking if the maintainer has a listed GitHub username.
105
106 If in doubt, check the associated package's maintainers. Please add the mentions above the `---` characters.
107 value: |2
108
109
110 ---
111
112 **Note for maintainers:** Please tag this issue in your pull request description. (i.e. `Resolves #ISSUE`.)
113 validations:
114 required: false
115 - type: "checkboxes"
116 id: "sanity-check"
117 attributes:
118 label: "I assert that this issue is relevant for Nixpkgs"
119 description: |
120 This bug tracker is for actionable issues that are not the result of user error. If you need help using your system and are unsure if this is a bug with Nixpkgs, please consider asking for help on the [NixOS Discourse](https://discourse.nixos.org/) or the [NixOS Matrix Space](https://matrix.to/#/#community:nixos.org) before opening an issue.
121 options:
122 - label: "I assert that this is a bug and not a support request."
123 required: true
124 - label: "I assert that this is not a [duplicate of an existing issue](https://github.com/NixOS/nixpkgs/issues?q=is%3Aopen+is%3Aissue+label%3A%220.kind%3A+bug%22+label%3A%226.topic%3A+nixos%22). "
125 required: true
126 - label: "I assert that I have read the [NixOS Code of Conduct](https://github.com/NixOS/.github/blob/master/CODE_OF_CONDUCT.md) and agree to abide by it."
127 required: true
128 - type: "markdown"
129 attributes:
130 value: |
131 # Thank you for helping improve Nixpkgs!
132
133 ---
134 - type: "textarea"
135 id: "prioritisation"
136 attributes:
137 label: "Is this issue important to you?"
138 description: |
139 **Please do not modify this text area!**
140
141 This template helps Nixpkgs developers know which issues should be prioritised by allowing users to vote with a :+1: reaction.
142 This is not a guarantee that highly-requested issues will be fixed first, but it helps us to figure out what's important to users. Please react on other users' issues if you find them important.
143 value: |
144 Add a :+1: [reaction] to [issues you find important].
145
146 [reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
147 [issues you find important]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc