Last Updated: September 09, 2019
·
1.246K
· simonowendesign

Commit Message Tips

Use imperative present tense e.g.
fix, add, change

Don't end lines with a period.

Keep whitespace commits separate.

If you're fixing an issue add fixes #xxx where xxx is the issue number.

If you're referencing an issue add #xxx where xxx is the issue number.

Start with a capital letter.

3 Responses
Add your response

Totally agree with 3) to 5). But do you have reasons for 1) and 2) ?

over 1 year ago ·

Start with a capital letter?

over 1 year ago ·

@derhasi, sorry for the late reply, just saw this.

1) Is more down to opinion (I personally prefer this way), it also states it here 'Describe your changes in imperative mood' - http://git.kernel.org/cgit/git/git.git/tree/Documentation/SubmittingPatches?id=HEAD

2) I've not encountered this issue, but it is considered best practice - https://wiki.openstack.org/wiki/GitCommitMessages#Summary_of_GIT_commit_message_structure

@leecrossley

Yup :)

over 1 year ago ·