nixpkgs/.github/ISSUE_TEMPLATE/missing_documentation.md

---
name: Missing or incorrect documentation
about: Help us improve the Nixpkgs and NixOS reference manuals
title: 'Documentation: '
labels: '9.needs: documentation'
assignees: ''

---

## Problem

<!-- describe your problem -->

## Proposal

<!-- propose a solution (optional) -->

## Checklist

<!-- make sure this issue is not redundant or obsolete -->

- [ ] checked [latest Nixpkgs manual] \([source][nixpkgs-source]) and [latest NixOS manual] \([source][nixos-source])
- [ ] checked [open documentation issues] for possible duplicates
- [ ] checked [open documentation pull requests] for possible solutions

[latest Nixpkgs manual]: https://nixos.org/manual/nixpkgs/unstable/
[latest NixOS manual]: https://nixos.org/manual/nixos/unstable/
[nixpkgs-source]: https://github.com/NixOS/nixpkgs/tree/master/doc
[nixos-source]: https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual
[open documentation issues]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+label%3A%229.needs%3A+documentation%22
[open documentation pull requests]: https://github.com/NixOS/nixpkgs/pulls?q=is%3Aopen+is%3Apr+label%3A%228.has%3A+documentation%22%2C%226.topic%3A+documentation%22

### Priorities

Add a :+1: [reaction] to [issues you find important].

[reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
[issues you find important]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc
add issue template for missing or incorrect documentation this allows anyone to create labelled issues for easy filtering. 2022-09-15 18:10:26 +02:00			`---`
			`name: Missing or incorrect documentation`
issue template: fill 'about' field according to [GitHub documentation] some fields are required. `about` is not listed, but it probably is required. [GitHub documentation]: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms 2022-09-19 10:07:09 +02:00			`about: Help us improve the Nixpkgs and NixOS reference manuals`
Update .github/ISSUE_TEMPLATE/missing_documentation.md Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> 2022-12-15 23:27:58 +01:00			`title: 'Documentation: '`
add issue template for missing or incorrect documentation this allows anyone to create labelled issues for easy filtering. 2022-09-15 18:10:26 +02:00			`labels: '9.needs: documentation'`
			`assignees: ''`

			`---`

			`## Problem`

			`<!-- describe your problem -->`

.github/ISSUE_TEMPLATE: Improvements 2022-12-04 12:25:43 +01:00			`## Proposal`

			`<!-- propose a solution (optional) -->`

add issue template for missing or incorrect documentation this allows anyone to create labelled issues for easy filtering. 2022-09-15 18:10:26 +02:00			`## Checklist`

			`<!-- make sure this issue is not redundant or obsolete -->`

fix typo 2022-10-04 22:45:29 +02:00			`- [ ] checked [latest Nixpkgs manual] \([source][nixpkgs-source]) and [latest NixOS manual] \([source][nixos-source])`
add issue template for missing or incorrect documentation this allows anyone to create labelled issues for easy filtering. 2022-09-15 18:10:26 +02:00			`- [ ] checked [open documentation issues] for possible duplicates`
			`- [ ] checked [open documentation pull requests] for possible solutions`

			`[latest Nixpkgs manual]: https://nixos.org/manual/nixpkgs/unstable/`
			`[latest NixOS manual]: https://nixos.org/manual/nixos/unstable/`
			`[nixpkgs-source]: https://github.com/NixOS/nixpkgs/tree/master/doc`
			`[nixos-source]: https://github.com/NixOS/nixpkgs/tree/master/nixos/doc/manual`
			`[open documentation issues]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+label%3A%229.needs%3A+documentation%22`
			`[open documentation pull requests]: https://github.com/NixOS/nixpkgs/pulls?q=is%3Aopen+is%3Apr+label%3A%228.has%3A+documentation%22%2C%226.topic%3A+documentation%22`

Encourage +1's for prioritisation Adds a small text to each issue and the PR template to encourage people to use :+1:'s for issues they're also interested in. See https://github.com/NixOS/nix.dev/issues/359 for more information Co-Authored-By: Valentin Gagarin <valentin.gagarin@tweag.io> 2023-11-21 07:00:18 +01:00			`### Priorities`

			`Add a :+1: [reaction] to [issues you find important].`

			`[reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/`
			`[issues you find important]: https://github.com/NixOS/nixpkgs/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc`