From: Kaartic Sivaraam Date: Wed, 26 Jan 2022 11:07:27 GMT Subject: Re: [RFC] Contributor doc: more on the proposed log message Message-ID: <700d8602-1efa-fe70-e9ff-5f5b7eb1a43c@gmail.com> In-Reply-To: On 24/01/22 3:02 am, brian m. carlson wrote: > On 2022-01-23 at 20:37:18, Junio C Hamano wrote: >> I have been thinking about making it more clear why we care about >> the log message, and noticed that we have CodingGuidelines and >> SubmittingPatches, both are specifically targetted for the >> contributors of THIS project (not to users contributing to a project >> that happens to use Git). >> >> I think the first thing to fix is that we have the "describe your >> changes well" section in the latter, as if it is not part of the >> code that is covered by CodingGuidelines. You formulate the thought >> on how to explain/sell your changes to others, and you sift the text >> you add to help fellow developers into the ones you leave in in-code >> comments and in the proposed log message, while you code. I am >> tempted to propose moving the part about proposed log message from >> SubmittingPatches to CodingGuidelines for this reason. >> >> Independent of the above, here is a small update I would add to >> clarify the project convention on the log message. >> >> Thoughts? > > I think this is a good idea, since it differs from the way people > usually discuss things outside of literature, and it's very common for > this to trip people up. > Precisely. I often get tripped up due to this whenever I write commit messages in general. So, good to have this clarified through a guideline. -- Sivaraam