From: Sebastian Wagner Date: Tue, 19 Oct 2021 09:07:13 +0000 (+0200) Subject: doc/start: documenting-ceph: Improve template of commits X-Git-Tag: v17.1.0~623^2~1 X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=260ed919fcd535b05d1b4a6576c6c3d901c234d9;p=ceph-ci.git doc/start: documenting-ceph: Improve template of commits by properly linking the corresponding tracker issue. Signed-off-by: Sebastian Wagner --- diff --git a/doc/start/documenting-ceph.rst b/doc/start/documenting-ceph.rst index 622494ba5e4..29f05c3efeb 100644 --- a/doc/start/documenting-ceph.rst +++ b/doc/start/documenting-ceph.rst @@ -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 ``. (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