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

HACKING: add github issue in commit msg instruction 

Change-Id: Ic6ef62531184e364285f2f90546eff9d613fb94a
This commit is contained in:
mpl 2015-07-01 19:41:05 +02:00
parent 7787b511e6
commit 37ea02da95
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
HACKING
View File

@ -73,16 +73,24 @@ $ 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. to gerrit for review.
You should also try to write a meaningful commit message, which at least states 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 in the first sentence what part or package of camlistore this commit is affecting.
following text should state what problem the change is addressing, and how. The following text should state what problem the change is addressing, and how.
An example would be: Finally, you should refer to the github issue(s) the commit is addressing, if any,
and with the appropriate keyword if the commit is fixing the issue. (See
https://help.github.com/articles/closing-issues-via-commit-messages/).
For example:
" "
HACKING: add tips about writing a commit message. pkg/search: add "file" predicate to search by file name
First time committers are not always aware about good commit message etiquette. File names were already indexed but there was no way to query the index for a file
These few notes should help them. by its name. The "file" predicate can now be used in search expressions (e.g. in the
search box of the web user interface) to achieve that.
Fixes #10987
" "
If your commit is adding or updating a vendored third party, you must indicate If your commit is adding or updating a vendored third party, you must indicate