doc(commit-message): in-depth explanation This article contains an in-depth explanation of what commit messages are, their origine, where they are used and how one can improve them. It is very common for students to overlook their git history and commit message. They don't do in-depth reviews, rarely discover their mate's work thanks to the `git log` and absolutely never `git blame` files. It is important they learn that it is not always possible to reach someone to ask questions about a bit of code (during a review or later while maintening a software) and that it is better if they can learn to be autonomous early. This complete article explain all that thanks to the enphasis on commit messages. May they not leave school knowing how to write clear commit messages, at least they'll leave school knowing it "is something" and that is is important "at least in some companies".

Julien Castiaux committed Mar 1, 2023

doc(commit-message): origine & structure This is an early draft of a new "explanation"-type document about commit messages. For now it explains the origine and structure (only title and trailers for now) of commit messages. Future additions will contains bits about where those messages are used (review/historic/blame) to give a better understanding of what should be inside them.

Julien Castiaux committed Feb 28, 2023