From a60234f9fd0f0c0be3f8de328433e41c8f81d314 Mon Sep 17 00:00:00 2001 From: mpl Date: Wed, 23 Oct 2013 17:15:05 +0200 Subject: [PATCH] HACKING: commit message tips Change-Id: I59e2646c745b91281507bed2383381b529b4869e --- HACKING | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/HACKING b/HACKING index b0f0ef3b9..4a659dc2b 100644 --- a/HACKING +++ b/HACKING @@ -73,9 +73,18 @@ $ devcam test You can use your usual git workflow to commit your changes, but for each change to be reviewed you should merge your commits into one before submitting -to gerrit for review with: +to gerrit for review. +You should also try to write a meaningful commit message, which at least states +in the first sentence what part of camlistore this commit is affecting. The +following text should state what problem the change is addressing, and how. +An example would be: -$ ./misc/review +" +HACKING: add tips about writing a commit message. + +First time committers are not always aware about good commit message etiquette. +These few notes should help them. +" You can optionally use our pre-commit hook so that your code gets gofmt'ed before being submitted (which should be done anyway). @@ -83,4 +92,8 @@ before being submitted (which should be done anyway). $ cd .git/hooks $ ln -s ../../misc/pre-commit.githook pre-commit +Finally, submit your code to gerrit with: + +$ ./misc/review + Please update this file as appropriate.