simple guideline on how to write good commit messages
I assume you know the "Golden Circle" model, invented by Simon Sinek. In case you don't I highly recommend to watch his Talk "How great leaders inspire action"
When creating a commit log we can increase its value imensly by following the same guidance.
- WHY do I change something (code/documentation)
- HOW do I achieve this goal
- WHAT do I do
Firstly we should always ask these questions before starting to actually change something And then, secondly we can utilise the same questions to create a great commit message.
- Commit message header: WHAT have I done (brief sumrary)
- Changeset: HOW have I achieved it
- Commit message body: WHY have I introduced this change (longer description + references)