aboutsummaryrefslogtreecommitdiff
path: root/home-manager/.github/PULL_REQUEST_TEMPLATE.md
diff options
context:
space:
mode:
Diffstat (limited to 'home-manager/.github/PULL_REQUEST_TEMPLATE.md')
-rw-r--r--home-manager/.github/PULL_REQUEST_TEMPLATE.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/home-manager/.github/PULL_REQUEST_TEMPLATE.md b/home-manager/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000000..eb6eca76250
--- /dev/null
+++ b/home-manager/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,44 @@
+### Description
+
+<!--
+
+Please provide a brief description of your change.
+
+-->
+
+### Checklist
+
+<!--
+
+Please go through the following checklist before opening a non-WIP
+pull-request.
+
+Also make sure to read the guidelines found at
+
+ https://github.com/rycee/home-manager/blob/master/doc/contributing.adoc#sec-guidelines
+
+-->
+
+- [ ] Change is backwards compatible.
+
+- [ ] Code formatted with `./format`.
+
+- [ ] Code tested through `nix-shell --pure tests -A run.all`.
+
+- [ ] Test cases updated/added. See [example](https://github.com/rycee/home-manager/commit/f3fbb50b68df20da47f9b0def5607857fcc0d021#diff-b61a6d542f9036550ba9c401c80f00ef).
+
+- [ ] Commit messages are formatted like
+
+ ```
+ {component}: {description}
+
+ {long description}
+ ```
+
+ See [CONTRIBUTING](https://github.com/rycee/home-manager/blob/master/doc/contributing.adoc#sec-commit-style) for more information and [recent commit messages](https://github.com/rycee/home-manager/commits/master) for examples.
+
+- If this PR adds a new module
+
+ - [ ] Added myself as module maintainer. See [example](https://github.com/rycee/home-manager/blob/068ff76a10e95820f886ac46957edcff4e44621d/modules/programs/lesspipe.nix#L6).
+
+ - [ ] Added myself and the module files to `.github/CODEOWNERS`.