path: root/docs
diff options
authorGravatar Thomas Petazzoni <thomas.petazzoni@bootlin.com>2018-11-24 11:19:03 +0100
committerGravatar Peter Korsgaard <peter@korsgaard.com>2019-01-16 09:23:44 +0100
commit74fc5dce223a2688b22e33961ccc28b7b3c43468 (patch)
tree700a97e2d4214c0b39ed173953abe7478c5bd43f /docs
parentd4dbcb036a8f3708eca974be3d6a62b1b4ca6bb0 (diff)
docs/manual: standardize a bit more the formatting of commit titles
Currently, our commit titles are not very well standardized, and it would be great to standardize them a little bit more. A number of people use "<pkg>: " as prefix, others use "package/<pkg>: ". Some people start the rest of the commit title (after the prefix) with an upper-case letter, some with a lower-case letter. In an attempt to standardize this, this commit updates the manual with some examples of good commit titles. Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Reviewed-by: Carlos Santos <casantos@datacom.com.br> Acked-by: Peter Korsgaard <peter@korsgaard.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
Diffstat (limited to 'docs')
1 files changed, 18 insertions, 3 deletions
diff --git a/docs/manual/contribute.txt b/docs/manual/contribute.txt
index 60bfb961f0..5530ce1546 100644
--- a/docs/manual/contribute.txt
+++ b/docs/manual/contribute.txt
@@ -194,14 +194,29 @@ bisect+ to locate the origin of a problem.
First of all, it is essential that the patch has a good commit
message. The commit message should start with a separate line with a
-brief summary of the change, starting with the name of the affected
-package. The body of the commit message should describe _why_ this
+brief summary of the change, prefixed by the area touched by the
+patch. A few examples of good commit titles:
+* +package/linuxptp: bump version to 2.0+
+* +configs/imx23evk: bump Linux version to 4.19+
+* +package/pkg-generic: postpone evaluation of dependency conditions+
+* +boot/uboot: needs host-{flex,bison}+
+* +support/testing: add python-ubjson tests+
+The description that follows the prefix should start with a lower case
+letter (i.e "bump", "needs", "postpone", "add" in the above examples).
+Second, the body of the commit message should describe _why_ this
change is needed, and if necessary also give details about _how_ it
was done. When writing the commit message, think of how the reviewers
will read it, but also think about how you will read it when you look
at this change again a few years down the line.
-Second, the patch itself should do only one change, but do it
+Third, the patch itself should do only one change, but do it
completely. Two unrelated or weakly related changes should usually be
done in two separate patches. This usually means that a patch affects
only a single package. If several changes are related, it is often