From: Anthony D'Atri Date: Sat, 30 Apr 2022 07:56:21 +0000 (-0700) Subject: SubmittingPatches: Improve SubmittingPatches example X-Git-Tag: v18.0.0~982^2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F46098%2Fhead;p=ceph.git SubmittingPatches: Improve SubmittingPatches example The example commit didn't show the convention of prefixing the message with the relative directory path where the file lives, which has led new contributors to innocently submit changes that aren't formatted ideally. This adds a path to the example. Signed-off-by: Anthony D'Atri --- diff --git a/SubmittingPatches.rst b/SubmittingPatches.rst index 4e01082fd9ea..f708b3c004f3 100644 --- a/SubmittingPatches.rst +++ b/SubmittingPatches.rst @@ -173,7 +173,7 @@ able to refer to the bug tracker easily. Here is an example showing a properly-formed commit message:: - doc: add "--foo" option to bar + doc/rados/mumble: Add "--foo" option to bar This commit updates the man page for bar with the newly added "--foo" option.