1. Programming 2: Structures »
  2. Vector with a project »
  3. About programming style »
  4. (Q) Good/bad commit message

(Q) Good/bad commit messageΒΆ

Goal: I can write a good commit message. (This is important especially in the project on this round, since also your use of version control will be evaluated.)

The longer the commit message is, the better.
The shorter the commit message is, the better.
It is useful to number commit messages (commit1, commit 2, and so on), to be able to know in which order they have been done.
A good commit message describes the mood you had while writing it.
A good commit message makes it easier to remember the content of the modification made.
It is a good idea to mention the target file(s) in the commit message.
It is a good idea to use a first-person mode in commit messages.
A good commit message tells what have been changed related to the previous version and why.
A good commit message tells how a change have been done.
A commit message should not have a long list of changes, but you should divide these changes into several commits.