1name: "Bug report (package)"
2description: "Create a generic bug report against a package."
3title: "PACKAGENAME: BUG TITLE"
4labels: ["0.kind: bug"]
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 **`PACKAGENAME: BUG TITLE`** template above with the correct package name (As seen in the [NixOS Package Search](https://search.nixos.org/packages)) and a short title summarising what the bug entails.
20
21 > [!TIP]
22 > For instance, if you were filing a bug against the [`hello`](https://search.nixos.org/packages?channel=unstable&from=0&size=1&buckets=%7B%22package_attr_set%22%3A%5B%22No%20package%20set%22%5D%2C%22package_license_set%22%3A%5B%22GNU%20General%20Public%20License%20v3.0%20or%20later%22%5D%2C%22package_maintainers_set%22%3A%5B%5D%2C%22package_platforms%22%3A%5B%5D%7D&sort=relevance&type=packages&query=hello) package about it failing to launch on ARM Linux, your title would be as follows:
23 > ```
24 > hello: fails to launch on aarch64-linux
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 **Maintainers** list of the offending package. This is done by by searching for the package on the [NixOS Package Search](https://search.nixos.org/packages) and mentioning the people listed under **Maintainers** by prefixing their GitHub usernames with an '@' character. Please add the mentions above the `---` characters in the template below.
103 value: |2
104
105
106 ---
107
108 **Note for maintainers:** Please tag this issue in your pull request description. (i.e. `Resolves #ISSUE`.)
109 validations:
110 required: false
111 - type: "checkboxes"
112 id: "sanity-check"
113 attributes:
114 label: "I assert that this issue is relevant for Nixpkgs"
115 description: |
116 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.
117 options:
118 - label: "I assert that this is a bug and not a support request."
119 required: true
120 - 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+darwin%22+-label%3A%226.topic%3A+nixos%22). "
121 required: true
122 - 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."
123 required: true
124 - type: "markdown"
125 attributes:
126 value: |
127 # Thank you for helping improve Nixpkgs!
128
129 ---
130 - type: "textarea"
131 id: "prioritisation"
132 attributes:
133 label: "Is this issue important to you?"
134 description: |
135 **Please do not modify this text area!**
136
137 This template helps Nixpkgs developers know which issues should be prioritised by allowing users to vote with a :+1: reaction.
138 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.
139 value: |
140 Add a :+1: [reaction] to [issues you find important].
141
142 [reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
143 [issues you find important]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc