Rooba
/
perkeep
mirror of https://github.com/perkeep/perkeep.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge "HACKING: commit message tips"

This commit is contained in:
Brad Fitzpatrick 2013-10-23 18:43:38 +00:00 committed by Gerrit Code Review
parent a3686d6ec0 a60234f9fd
commit 008cf7325f
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
HACKING
View File

@ -68,9 +68,18 @@ $ devcam test
You can use your usual git workflow to commit your changes, but for each 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 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 You can optionally use our pre-commit hook so that your code gets gofmt'ed
before being submitted (which should be done anyway). before being submitted (which should be done anyway).
@ -78,4 +87,8 @@ before being submitted (which should be done anyway).
$ cd .git/hooks $ cd .git/hooks
$ ln -s ../../misc/pre-commit.githook pre-commit $ ln -s ../../misc/pre-commit.githook pre-commit
Finally, submit your code to gerrit with:
$ ./misc/review
Please update this file as appropriate. Please update this file as appropriate.