summaryrefslogtreecommitdiff
path: root/.github/pull_request_template.md
diff options
context:
space:
mode:
Diffstat (limited to '.github/pull_request_template.md')
-rw-r--r--.github/pull_request_template.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 00000000..7b3a25f3
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,32 @@
+<!-- This won't be rendered!
+[CHECKLIST]
+I prefixed the title with one of the following tags:
+ - [Feature]: For feature addition / improvements
+ - [Bugfix]: When fixing a functionality
+ - [Refactor]: When moving code without adding any functionality
+ - [Doc]: On documentation updates
+
+- I read the contributing guide (CONTRIBUTING.md)
+- My code follows the style guidelines of this project
+- I have performed a self-review of my code
+- I have commented on my code, particularly in hard-to-understand areas
+- I have made corresponding changes to the documentation
+- My changes generate no new warnings
+-->
+# Description
+
+Please include a summary of the change and which issue is fixed. \
+List any dependencies that are required for this change.
+
+Fixes #(issue)
+
+## 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 any relevant details for your test configuration.
+
+- Run command `:mycommand`
+- Check logs
+- ...
+