]> git.proxmox.com Git - ceph.git/blobdiff - ceph/.github/pull_request_template.md
import quincy beta 17.1.0
[ceph.git] / ceph / .github / pull_request_template.md
index 46ad1113ddd19f50e5c30e87ea83e2c0431f0b0b..a5008307f05cd866b8cabeca47fa6dc9d88f4ed8 100644 (file)
@@ -1,41 +1,45 @@
 
-<!--
-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]
+<!--
+  - Please give your pull request a title like
 
-[A longer multiline description]
+      [component]: [short description]
 
-Fixes: [ticket URL on tracker.ceph.com, create one if necessary]
-Signed-off-by: [Your Name] <[your email]>
-"""
+  - Please use this format for each git commit message:
 
-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.
+      [component]: [short description]
 
-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.
+      [A longer multiline description]
 
-For more examples, simply use "git log" and look at some historical commits.
+      Fixes: [ticket URL on tracker.ceph.com, create one if necessary]
+      Signed-off-by: [Your Name] <[your email]>
 
-This was just a quick overview.  More information for contributors is available here:
-https://raw.githubusercontent.com/ceph/ceph/master/SubmittingPatches.rst
+    For examples, use "git log".
 
+  - 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>
 -->
-## Checklist
-- [ ] References tracker ticket
-- [ ] Updates documentation if necessary
-- [ ] Includes tests for new functionality or reproducer for bug
 
----
+## Checklist
+- Tracker (select at least one)
+  - [ ] References tracker ticket
+  - [ ] Very recent bug; references commit where it was introduced
+  - [ ] New feature (ticket optional)
+  - [ ] Doc update (no ticket needed)
+  - [ ] Code cleanup (no ticket needed)
+- Component impact
+  - [ ] Affects [Dashboard](https://tracker.ceph.com/projects/dashboard/issues/new), opened tracker ticket
+  - [ ] Affects [Orchestrator](https://tracker.ceph.com/projects/orchestrator/issues/new), opened tracker ticket
+  - [ ] No impact that needs to be tracked
+- Documentation (select at least one)
+  - [ ] Updates relevant documentation
+  - [ ] No doc update is appropriate
+- Tests (select at least one)
+  - [ ] Includes [unit test(s)](https://docs.ceph.com/en/latest/dev/developer_guide/tests-unit-tests/)
+  - [ ] Includes [integration test(s)](https://docs.ceph.com/en/latest/dev/developer_guide/testing_integration_tests/)
+  - [ ] Includes bug reproducer
+  - [ ] No tests
 
 <details>
 <summary>Show available Jenkins commands</summary>