pyrox.dev
1name: "Request: documentation"
2description: "Report missing or incorrect documentation in the NixOS or Nixpkgs manuals."
3title: "Missing Documentation: PACKAGENAME"
4labels: ["0.kind: enhancement", "9.needs: documentation"]
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 **`Missing Documentation: PACKAGENAME`** template above with the correct package name (As seen in the [NixOS Package Search](https://search.nixos.org/packages)) or module name (As seen in the [NixOS Option Search](https://search.nixos.org/options)).
20
21 > [!TIP]
22 > For instance, if you were filing an issue 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 not having any NixOS-specific documentation, your title would be as follows:
23 > ```
24 > Missing Documentation: hello
25 > ```
26
27 ---
28 - type: "textarea"
29 id: "description"
30 attributes:
31 label: "Describe the problem"
32 description: "Please include a clear and concise description of what the issue is."
33 validations:
34 required: true
35 - type: "textarea"
36 id: "proposal"
37 attributes:
38 label: "Proposed solution"
39 description: |
40 If possible, please draft a tentative documentation chapter to resolve this issue.
41 Your proposal should be written in CommonMark Markdown, optionally enhanced with [Nix-specific extensions](https://github.com/NixOS/nixpkgs/tree/master/doc#syntax).
42 render: "markdown"
43 validations:
44 required: false
45 - type: "textarea"
46 id: "maintainers"
47 attributes:
48 label: "Notify maintainers"
49 description: |
50 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.
51 value: |2
52
53
54 ---
55
56 **Note for maintainers:** Please tag this issue in your pull request description. (i.e. `Resolves #ISSUE`.)
57 validations:
58 required: false
59 - type: "checkboxes"
60 id: "sanity-check"
61 attributes:
62 label: "I assert that this issue is relevant for Nixpkgs"
63 options:
64 - label: "I assert that this request is not already implemented in the latest [NixOS](https://nixos.org/manual/nixos/unstable/) or [Nixpkgs](https://nixos.org/manual/nixpkgs/unstable/) manuals."
65 required: true
66 - label: "I assert that this is not a [duplicate of an existing documentation issue](https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+label%3A%229.needs%3A+documentation%22)."
67 required: true
68 - 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."
69 required: true
70 - type: "markdown"
71 attributes:
72 value: |
73 # Thank you for helping improve Nixpkgs!
74
75 ---
76 - type: "textarea"
77 id: "priorisation"
78 attributes:
79 label: "Is this issue important to you?"
80 description: |
81 **Please do not modify this text area!**
82
83 This template helps Nixpkgs developers know which issues should be prioritised by allowing users to vote with a :+1: reaction.
84 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.
85 value: |
86 Add a :+1: [reaction] to [issues you find important].
87
88 [reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
89 [issues you find important]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc