File tree Expand file tree Collapse file tree 2 files changed +910
-0
lines changed Expand file tree Collapse file tree 2 files changed +910
-0
lines changed Original file line number Diff line number Diff line change 1+ TITLE: Commit message conventions
2+
3+ The format of commit message should be a short description of what you did.
4+ After the description, the bug ID, review ID or anything else.
5+
6+ The commit log should not contain the obvious. If you change file Foo.cpp:
7+
8+ BAD:
9+ "Fix bug in Foo.cpp"
10+ BAD:
11+ "Fix #45"
12+ BAD:
13+ "Commit Foo.cpp"
14+ GOOD:
15+ "Fix buffer overflow (close #45)."
16+
17+ The above does not mean that when you do a complex change do not write a
18+ description of what you did, on the contrary. When a long description is
19+ needed do add as much as needed to explain the change, just do not add
20+ meaningless information (committing Foo.cpp etc.)
21+
22+ It is advisable to split complex commits to several smaller commits if
23+ possible. If you see that your commit massage contain more then one topic, you
24+ probably can and should split the commit into a few unrelated commits.
You can’t perform that action at this time.
0 commit comments