Commit messages - iToto/developmentCycle GitHub Wiki
Most version control systems have commit messages. These messages are there to summarize the purpose of the code changes contained in a commit.
- Short
- Informative
- Accurate
You don’t need to write a book. A sentence or two should suffice. If you’re describing more than a few changes then your commit contains too many things and should be split into multiple commits.
A message like “I changed some code” is pointless and may as well be omitted completely. Describe what kind of changes were made and why. Including the issue# you’ve been working on can also make it easier to cross reference your work.
Make sure you’re writing the right message for the commit you’re making. It can be quite frustrating when messages get mixed up and people are trying to make sense of code changes after reading the wrong description.
It may sound somewhat annoying and time consuming for some people to have to put in this level of effort for commits. These accurate commit messages are not only for your own use but for the use of your current and future team mates.