summary refs log tree commit diff
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
authorValentin Gagarin <valentin.gagarin@tweag.io>2022-09-15 18:10:26 +0200
committerValentin Gagarin <valentin.gagarin@tweag.io>2022-09-16 09:57:32 +0200
commit8277d184456592ffe165a961ba65e2cb7b3eed75 (patch)
treed616930719c812a3d4ee6ab1050f3c3a7be151f0 /.github/ISSUE_TEMPLATE
parent1637945189070199494480264357738cc946c70c (diff)
downloadnixpkgs-8277d184456592ffe165a961ba65e2cb7b3eed75.tar
nixpkgs-8277d184456592ffe165a961ba65e2cb7b3eed75.tar.gz
nixpkgs-8277d184456592ffe165a961ba65e2cb7b3eed75.tar.bz2
nixpkgs-8277d184456592ffe165a961ba65e2cb7b3eed75.tar.lz
nixpkgs-8277d184456592ffe165a961ba65e2cb7b3eed75.tar.xz
nixpkgs-8277d184456592ffe165a961ba65e2cb7b3eed75.tar.zst
nixpkgs-8277d184456592ffe165a961ba65e2cb7b3eed75.zip
add issue template for missing or incorrect documentation
this allows anyone to create labelled issues for easy filtering.
Diffstat (limited to '.github/ISSUE_TEMPLATE')
-rw-r--r--.github/ISSUE_TEMPLATE/missing_documentation.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/missing_documentation.md b/.github/ISSUE_TEMPLATE/missing_documentation.md
new file mode 100644
index 00000000000..81c05af09c9
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/missing_documentation.md
@@ -0,0 +1,32 @@
+---
+name: Missing or incorrect documentation
+about:
+title: ''
+labels: '9.needs: documentation'
+assignees: ''
+
+---
+
+## Problem
+
+<!-- describe your problem -->
+
+## 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
+
+## Proposal
+
+<!-- propose a solution -->
+