Currently, we do not have a standard for git message guidelines, so the
commit logs may look a little untidy [1].

A very popular commit guideline is from Angular.js [2], which I think is
very nice only that it includes issue number at the footer.
For example, with Angular.js's commit guideline, a commit message may be:
fix(svg): change the default behavior of download image with toolbox
fix #12345

I think putting the issue number at the end of the subject may be a better
idea.
Because if the issue number is not included in the first line, it will only
be visible when "..." is clicked.
Issue number, and more importantly, the link to the issue is a very
important part of a git message.
[image: commit message.png]

My suggest is, to follow the Angular.js git message guidelines, and change
about the issue number part, making it something like:

fix(svg): change the default behavior of download image with toolbox; fix
#12345


[1] https://github.com/apache/incubator-echarts/commits/master
[2]
https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines

Wenli

Reply via email to