aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.github/pull_request_template.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 00000000..871b946e
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,15 @@
+<!--
+WHEN OPENING A PULL REQUEST KEEP IN MIND:
+-> If the changes you made can be summarised in a screenshot, add one (e.g. you changed the layout of an in-game menu)
+-> If the changes you made can be summarised in a screenrecording, add one (e.g. proof that you fixed a certain bug)
+
+-> Please use a sensible title for your pull request
+
+-> Please describe the changes you made. The easier it is to understand what you changed, the higher the chances of your PR being merged (in a timely manner).
+
+-> If you made multiple independent changes, please make a new PR for each one. This prevents your PR being blocked from merging by one of the changes you made.
+
+Note that commit messages in PRs will generally be squashed to keep commit history clean.
+-->
+
+Replace this line with a description of your change (and screenshots/screenrecordings if applicable).