]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: Create pull_request_template.md 23185/head
authorJohn Spray <john.spray@redhat.com>
Mon, 16 Jul 2018 11:43:12 +0000 (12:43 +0100)
committerJohn Spray <john.spray@redhat.com>
Mon, 30 Jul 2018 22:43:50 +0000 (23:43 +0100)
Let's take the opportunity to nudge new contributors
to have well formatted commit messages.

Signed-off-by: John Spray <john.spray@redhat.com>
.github/pull_request_template.md [new file with mode: 0644]

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644 (file)
index 0000000..bcd25ac
--- /dev/null
@@ -0,0 +1,37 @@
+
+<!--
+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
+
+-->
+
+- [ ] References tracker ticket
+- [ ] Updates documentation if necessary
+- [ ] Includes tests for new functionality or reproducer for bug
+