ceph/.github/pull_request_template.md

   1
   2 <!--
   3 Thank you for opening a pull request!  Here are some tips on creating
   4 a well formatted contribution.
   5
   6 Please give your pull request a title like "[component]: [short description]"
   7
   8 This is the format for commit messages:
   9
  10 """
  11 [component]: [short description]
  12
  13 [A longer multiline description]
  14
  15 Fixes: [ticket URL on tracker.ceph.com, create one if necessary]
  16 Signed-off-by: [Your Name] <[your email]>
  17 """
  18
  19 The Signed-off-by line is important, and it is your certification that
  20 your contributions satisfy the Developers Certificate or Origin.  For
  21 more detail, see SubmittingPatches.rst.
  22
  23 The component is the short name of a major daemon or subsystem,
  24 something like "mon", "osd", "mds", "rbd, "rgw", etc. For ceph-mgr modules,
  25 give the component as "mgr/<module name>" rather than a path into pybind.
  26
  27 For more examples, simply use "git log" and look at some historical commits.
  28
  29 This was just a quick overview.  More information for contributors is available here:
  30 https://raw.githubusercontent.com/ceph/ceph/master/SubmittingPatches.rst
  31
  32 -->
  33
  34 - [ ] References tracker ticket
  35 - [ ] Updates documentation if necessary
  36 - [ ] Includes tests for new functionality or reproducer for bug
  37