On Thu, Mar 24, 2016 at 9:53 PM, Junio C Hamano <[email protected]> wrote: > Pranit Bauva <[email protected]> writes: > >> A general convention followed by git users it to write the commit >> message as "What he did to the code?" rather than "What problem was >> there in the code?" > > It is OK for other projects to adopt a different convention, but The > project convention here is different. > > We tend to write our log message like this in this order: > > - Explain relevant behaviour and code structure in the current code > to refresh memory of readers to help them understand the next two > items better. This paragraph is optional and you see it only in > difficult patches. > > - Desribe the problem. What the end user would do and what she > sees in response to it, why that is not a good outcome, and what > would be a better outcome. For a patch to only improve code, > replace "the end user" with "other codepaths that interact with > the code being changed". > > - Explain the approach to implement a better outcome. This > paragraph is optional and you see it only in patches that > implement tricky solutions. > > - Describe the solution, as if you are giving orders to the > maintainers to change the code this way and that way.
Thanks for making it clearer to me! I tend to write bad commit messages. Improving on it though. -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html
