Git Commit Rules

Make smaller, logically related commits rather than one huge commit. Make sure that each commit is accompanied by a commit message that follows the example below. The first line should be a short description of WHAT the commit does written in imperative mood. It should not exceed 50 columns of text width and the trailing period should be omitted. The next line should be empty. Optionally, you may provide additional paragraphs that explain WHY the change was made. The text should not exceed 72 columns of width. Note that some editors will help you follow these rules by text highlighting. The entire commit message must be written in English.

An example commit message may look like this:

Location service sometimes needs to be able to process requests in
parallel in order to avoid deadlock.

Another very good example of how the WHY description should look like is in commit 63a045c41ff.

Last modified 6 years ago Last modified on 2018-10-11T07:56:50Z
Note: See TracWiki for help on using the wiki.