aboutsummaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorValentin Gagarin <valentin.gagarin@tweag.io>2022-09-15 18:16:17 +0200
committerValentin Gagarin <valentin.gagarin@tweag.io>2022-09-15 18:16:17 +0200
commit84fb036062b879c454188a2a4f7123720a6eb9be (patch)
treecdc4bfba1fcf5cee93bb7eb8eb82bcac2a5e1dc6 /.github
parent88a45d6149c0e304f6eb2efcc2d7a4d0d569f8af (diff)
add issue template for missing or incorrect documentation
this allows anyone to create labelled issues for easy filtering.
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/missing_documentation.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/missing_documentation.md b/.github/ISSUE_TEMPLATE/missing_documentation.md
new file mode 100644
index 000000000..84868814f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/missing_documentation.md
@@ -0,0 +1,28 @@
+---
+name: Missing or incorrect documentation
+about:
+title: ''
+labels: 'documentation'
+assignees: ''
+
+---
+
+## Problem
+
+<!-- describe your problem -->
+
+## Checklist
+
+<!-- make sure this issue is not redundant or obsolete -->
+
+- [ ] checked [latest Nix manual]\ ([source])
+- [ ] checked [open documentation issues and pull requests] for possible duplicates
+
+[latest Nix manual]: https://nixos.org/manual/nix/unstable/
+[source]: https://github.com/NixOS/nix/tree/master/doc/manual/src
+[open documentation issues and pull requests]: https://github.com/NixOS/nix/labels/documentation
+
+## Proposal
+
+<!-- propose a solution -->
+