For anyone wanting to read the specific document: https://git-scm.com/docs/SubmittingPatches#describe-changes https://git-scm.com/docs/SubmittingPatches#descri

For anyone wanting to read the specific document: https://git-scm.com/docs/SubmittingPatches#describe-changes https://git-scm.com/docs/SubmittingPatches#describe-changes To be clear, the document does lead with: > Please note that this information is only relevant to you if you plan on contributing to the Git project itself. It is in no shape or form required reading for regular Git users. In spite of that qualifier, I think that the directions offered do apply extremely well as general guide, too. > Your code may be clearly written with in-code comment to sufficiently explain how it works with the surrounding code, but those who need to fix or enhance your code in the future will need to know why your code does what it does. [...] You do not have to say "Currently"---the status quo in the problem statement is about the code without your change ...