summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorSimon Hauser <Simon-Hauser@outlook.de>2022-06-18 13:57:25 +0200
committerGitHub <noreply@github.com>2022-06-18 13:57:25 +0200
commitd88b44ddf14670cffa9fdb1eaca7a0429a973653 (patch)
treef626c663569ed9a5429b9d66b73b2b062ed97ad5 /.github
parentc0a76f8a395b6461e3a28cff03687f125fd106ab (diff)
chore: PR template (#2012)
* chore: PR template * slim it down
Diffstat (limited to '.github')
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..780091e
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,33 @@
+# Description
+
+Please include a summary of the change and which issue is fixed. Please also
+include relevant motivation and context
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- Bug fix (non-breaking change which fixes an issue)
+- New feature (non-breaking change which adds functionality)
+- Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- This change requires a documentation update
+
+# How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list relevant details about your configuration
+
+- [ ] Test A
+- [ ] Test B
+
+**Configuration**:
+* Neovim version (nvim --version):
+* Operating system and version:
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project (stylua)
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation (lua annotations)