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.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 000000000..c62641f08
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,37 @@
+[//]: # (**********************************)
+[//]: # (** Fill in the following fields **)
+[//]: # (**********************************)
+
+[//]: # (Note: Lines beginning with syntax such as this one, are comments and will not be visible in your report!)
+
+### Pull Request Prelude
+
+[//]: # (Thank you for working on improving Hercules!)
+
+[//]: # (Please complete these steps and check the following boxes by putting an `x` inside the brackets _before_ filing your Pull Request.)
+
+- [ ] I have followed [proper Hercules code styling][code].
+- [ ] I have read and understood the [contribution guidelines][cont] before making this PR.
+- [ ] I am aware that this PR will be closed if the above-mentioned criteria are not fulfilled.
+
+### Changes Proposed
+
+[//]: # (Describe at length, the changes that this pull request makes.)
+
+**Affected Branches:**
+
+[//]: # (Master? Slave?)
+
+**Issues addressed:**
+
+[//]: # (Issue Tracker Number if any.)
+
+### Known Issues and TODO List
+
+[//]: # (Insert checklist here)
+[//]: # (Syntax: - [ ] Checkbox)
+
+[//]: # (**NOTE** Enable the setting "[√] Allow edits from maintainers." when creating your pull request if you have not already enabled it.)
+
+[cont]: https://github.com/HerculesWS/Hercules/blob/master/CONTRIBUTING.md
+[code]: https://github.com/HerculesWS/Hercules/wiki/Coding-Style