[Qgis-developer] Please stop spamming commit logs!

Matthias Kuhn matthias.kuhn at gmx.ch
Fri Oct 10 02:53:28 PDT 2014


To make an example, this is a good commit message.

https://github.com/qgis/QGIS/commit/a132bc9a9e318c2321c8fba13dc9503b4d11e2aa

It states
  * which problem it solves
  * and what it does exactly

And I could not care less about an additional line at the bottom stating 
"Funded by John Wayne"

- Matthias

On 10/10/2014 10:49 AM, Sandro Santilli wrote:
> On Fri, Oct 10, 2014 at 10:18:53AM +0200, Matthias Kuhn wrote:
>> I agree with Nathan and Nyall. The commit history isn't a very
>> "official" thing, so there is some room for attribution and other
>> additional information.
>>
>> Personally I prefer a meaningful commit message with some "spam" in
>> it over a commit message that contains (almost) no useful
>> information like "Fix #1234", "Fix #4567 [Meaningless title of an
>> issue report]" "Followup 65443" (That one is not so bad, but could
>> be improved with some prose). I often find myself looking at the
>> commit history to find information about why something was done.
>> IF something needs to be fixed in the commit log, then we should
>> rather focus on this than on a bit of pride, fun and attribution.
> +1
>
> On a related note, keeping commit lines within 70 columns and
> separating short description line from long description body
> with two newlines also helps a lot :)
>
> --strk;



More information about the Qgis-developer mailing list