]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
.github: add a "Contribution Guidelines" to the pull request template
authorLaura Flores <lflores@redhat.com>
Fri, 22 Apr 2022 23:06:09 +0000 (23:06 +0000)
committerLaura Flores <lflores@redhat.com>
Fri, 22 Apr 2022 23:11:58 +0000 (23:11 +0000)
These guidelines refer contributors to the "Submitting Patches to Ceph" doc
and the "Submitting Patches to Ceph - Backports" doc. Even though there are
already tips for titling/signing commits in the PR template, these tips
are commented out and easy to gloss over once the contributor creates the
PR. These existing tips do not include any pointers about staging backports.

Fixes: https://tracker.ceph.com/issues/55418
Signed-off-by: Laura Flores <lflores@redhat.com>
.github/pull_request_template.md

index c213c50e218b6b98ac6459738af34e5496ea0c48..48ba87d755acc097451e03cb999da01ad84b9e3e 100644 (file)
   - The Signed-off-by line in every git commit is important; see <span class="x x-first x-last">[Submitting Patches to Ceph](https://github.com/ceph/ceph/blob/master/</span>SubmittingPatches.rst<span class="x x-first x-last">)</span>
 -->
 
+## Contribution Guidelines
+- To sign and title your commits, please refer to [Submitting Patches to Ceph](https://github.com/ceph/ceph/blob/master/SubmittingPatches.rst).
+
+- If you are submitting a fix for a stable branch (e.g. "pacific"), please refer to [Submitting Patches to Ceph - Backports](https://github.com/ceph/ceph/blob/master/SubmittingPatches-backports.rst) for the proper workflow.
+
 ## Checklist
 - Tracker (select at least one)
   - [ ] References tracker ticket