summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
Diffstat (limited to '.github')
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..2b59d10a
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,30 @@
+## Proposed Commit Message
+<!-- Include a proposed commit message because all PRs are squash merged -->
+
+> summary: no more than 70 characters
+>
+> A description of what the change being made is and why it is being
+> made, if the summary line is insufficient. The blank line above is
+> required. This should be wrapped at 72 characters, but otherwise has
+> no particular length requirements.
+>
+> If you need to write multiple paragraphs, feel free.
+>
+> LP: #NNNNNNN (replace with the appropriate bug reference or remove
+> this line entirely if there is no associated bug)
+
+## Additional Context
+<!-- If relevant -->
+
+## Test Steps
+<!-- Please include any steps necessary to verify (and reproduce if
+this is a bug fix) this change on a live deployed system,
+including any necessary configuration files, user-data,
+setup, and teardown. Scripts used may be attached directly to this PR. -->
+
+## Checklist:
+<!-- Go over all the following points, and put an `x` in all the boxes
+that apply. -->
+ - [ ] My code follows the process laid out in [the documentation](https://cloudinit.readthedocs.io/en/latest/topics/hacking.html)
+ - [ ] I have updated or added any unit tests accordingly
+ - [ ] I have updated or added any documentation accordingly