mirror of
https://github.com/ceph/ceph
synced 2024-12-29 23:12:27 +00:00
b982c28651
Let's take the opportunity to nudge new contributors to have well formatted commit messages. Signed-off-by: John Spray <john.spray@redhat.com>
38 lines
1.2 KiB
Markdown
38 lines
1.2 KiB
Markdown
|
|
<!--
|
|
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
|
|
|