tjh.dev
1name: "Request: NixOS module"
2description: "Create a new NixOS Module request for an existing package."
3title: "Module Request: nixos/MODULENAME"
4labels: ["0.kind: enhancement", "6.topic: nixos", "9.needs: module (new)"]
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 **`Module Request: nixos/MODULENAME`** template above with the correct module name (As seen in the [NixOS Option Search](https://search.nixos.org/options)).
20
21 > [!TIP]
22 > For instance, if you were filing a request against the missing `hello` module, your title would be as follows:
23 > ```
24 > Module Request: nixos/hello
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 or stable version, please update to the latest **unstable** version and check if the module still does not exist before continuing this request.
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 proposed module"
47 description: "Please include a clear and concise description of what the module should accomplish."
48 validations:
49 required: true
50 - type: "textarea"
51 id: "additional-context"
52 attributes:
53 label: "Additional context"
54 description: "Add any other context about the proposed module here."
55 validations:
56 required: false
57 - type: "textarea"
58 id: "maintainers"
59 attributes:
60 label: "Notify maintainers"
61 description: |
62 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.
63 value: |2
64
65
66 ---
67
68 **Note for maintainers:** Please tag this issue in your pull request description. (i.e. `Resolves #ISSUE`.)
69 validations:
70 required: false
71 - type: "checkboxes"
72 id: "sanity-check"
73 attributes:
74 label: "I assert that this issue is relevant for Nixpkgs"
75 options:
76 - label: "I assert that this module does not yet exist in an [open pull request](https://github.com/NixOS/nixpkgs/pulls?q=is%3Aopen+is%3Apr+label%3A%228.has%3A+module+%28new%29%22) or in [NixOS Unstable](https://search.nixos.org/options?channel=unstable)."
77 required: true
78 - 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%229.needs%3A+module+%28new%29%22). "
79 required: true
80 - 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."
81 required: true
82 - type: "markdown"
83 attributes:
84 value: |
85 # Thank you for helping improve NixOS!
86
87 ---
88 - type: "textarea"
89 id: "prioritisation"
90 attributes:
91 label: "Is this issue important to you?"
92 description: |
93 **Please do not modify this text area!**
94
95 This template helps Nixpkgs developers know which issues should be prioritised by allowing users to vote with a :+1: reaction.
96 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.
97 value: |
98 Add a :+1: [reaction] to [issues you find important].
99
100 [reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
101 [issues you find important]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc