From: Nathan Cutler Date: Wed, 23 May 2018 18:18:30 +0000 (+0200) Subject: doc/SubmittingPatches.rst: use Google style guide for doc patches X-Git-Tag: v14.0.0~34^2~1 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=6f2e7cada8f59165b81a0924e067c9d51eecc09f;p=ceph.git doc/SubmittingPatches.rst: use Google style guide for doc patches Signed-off-by: Nathan Cutler --- diff --git a/SubmittingPatches.rst b/SubmittingPatches.rst index 33345045b7f..243ec83fd88 100644 --- a/SubmittingPatches.rst +++ b/SubmittingPatches.rst @@ -12,11 +12,10 @@ The patch signing procedures and definitions are unmodified. SIGNING CONTRIBUTIONS ===================== -In order to keep the record of code attribution clean within the -source repository, please follow these guidelines for signing -patches submitted to the project. These definitions are taken -from those used by the Linux kernel and many other open source -projects. +In order to keep the record of code attribution clean within the source +repository, follow these guidelines for signing patches submitted to the +project. These definitions are taken from those used by the Linux kernel +and many other open source projects. 1. Sign your work @@ -490,6 +489,9 @@ contact the component lead, who should arrange for the missing section to be created with sufficient detail for the patch submitter to document their changes. +When writing and/or editing documentation, follow the Google Developer +Documentation Style Guide: https://developers.google.com/style/ + 6. Style check your changes ---------------------------