]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/start: documenting-ceph: Improve template of commits
authorSebastian Wagner <sewagner@redhat.com>
Tue, 19 Oct 2021 09:07:13 +0000 (11:07 +0200)
committerSebastian Wagner <sewagner@redhat.com>
Wed, 20 Oct 2021 12:18:20 +0000 (14:18 +0200)
by properly linking the corresponding tracker issue.

Signed-off-by: Sebastian Wagner <sewagner@redhat.com>
doc/start/documenting-ceph.rst

index 622494ba5e48a5416b1b20aa49e233a63509a511..29f05c3efebfced3e9721ab4a353c922e99837bd 100644 (file)
@@ -411,7 +411,7 @@ Ceph documentation commits are simple, but follow a strict convention:
 - The comment summary MUST be one line only. (strict)
 - Additional comments MAY follow a blank line after the summary, 
   but should be terse.
-- A commit MAY include ``Fixes: #{bug number}``.
+- A commit MAY include ``Fixes: https://tracker.ceph.com/issues/{bug number}``.
 - Commits MUST include ``Signed-off-by: Firstname Lastname <email>``. (strict)
 
 .. tip:: Follow the foregoing convention particularly where it says 
@@ -429,7 +429,7 @@ The following comment includes a reference to a bug. ::
 
        doc: Fixes a spelling error and a broken hyperlink.
 
-       Fixes: #1234
+       Fixes: https://tracker.ceph.com/issues/1234
        
        Signed-off-by: John Doe <john.doe@gmail.com>