summaryrefslogtreecommitdiffstats
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.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 000000000..46ad1113d
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,58 @@
+
+<!--
+Thank you for opening a pull request! Here are some tips on creating
+a well formatted contribution.
+
+Please give your pull request a title like "[component]: [short description]"
+
+This is the format for commit messages:
+
+"""
+[component]: [short description]
+
+[A longer multiline description]
+
+Fixes: [ticket URL on tracker.ceph.com, create one if necessary]
+Signed-off-by: [Your Name] <[your email]>
+"""
+
+The Signed-off-by line is important, and it is your certification that
+your contributions satisfy the Developers Certificate or Origin. For
+more detail, see SubmittingPatches.rst.
+
+The component is the short name of a major daemon or subsystem,
+something like "mon", "osd", "mds", "rbd, "rgw", etc. For ceph-mgr modules,
+give the component as "mgr/<module name>" rather than a path into pybind.
+
+For more examples, simply use "git log" and look at some historical commits.
+
+This was just a quick overview. More information for contributors is available here:
+https://raw.githubusercontent.com/ceph/ceph/master/SubmittingPatches.rst
+
+-->
+## Checklist
+- [ ] References tracker ticket
+- [ ] Updates documentation if necessary
+- [ ] Includes tests for new functionality or reproducer for bug
+
+---
+
+<details>
+<summary>Show available Jenkins commands</summary>
+
+- `jenkins retest this please`
+- `jenkins test classic perf`
+- `jenkins test crimson perf`
+- `jenkins test signed`
+- `jenkins test make check`
+- `jenkins test make check arm64`
+- `jenkins test submodules`
+- `jenkins test dashboard`
+- `jenkins test dashboard cephadm`
+- `jenkins test api`
+- `jenkins test docs`
+- `jenkins render docs`
+- `jenkins test ceph-volume all`
+- `jenkins test ceph-volume tox`
+
+</details>