Nice - more information is always better. The "why" of changes is particularly important for other devs and future you.
One step better is writing your detailed descriptions in the body of commit messages; then it's in the history and directly accessible through whatever interface you use to git blame. All of the Git web platforms support this well, including copying the commit body to the description of a pull request.
Nice - more information is always better. The "why" of changes is particularly important for other devs and future you.
One step better is writing your detailed descriptions in the body of commit messages; then it's in the history and directly accessible through whatever interface you use to
git blame. All of the Git web platforms support this well, including copying the commit body to the description of a pull request.Facebook's tool Phabricator has an excellent article on writing reviewable code + writing good commit messages which goes into more detail.
Completely agree. The article which you mentioned is a great guidance.