[riot-devel] Lifting the 50 characters commit first line limit?

Nikander Pekka pekka.nikander at aalto.fi
Wed Oct 10 12:43:03 CEST 2018


Hi Martin,

https://github.com/RIOT-OS/RIOT/pull/10142

--Pekka

On 10.10.2018, at 13:24, Martine Lenders <mail at martine-lenders.eu> wrote:

Hi Pekka,

feel free to change the check script [1] to whatever is most comfortable to you :-) (sorry today I'm very busy so I can't do it myself; but I'm happy to review it once ready).

Regards,
Martine

[1] https://github.com/RIOT-OS/RIOT/blob/master/dist/tools/commit-msg/check.sh

Am Mi., 10. Okt. 2018 um 12:14 Uhr schrieb Nikander Pekka <pekka.nikander at aalto.fi<mailto:pekka.nikander at aalto.fi>>:
Thanks Martine and all!

My memory is bad.  Now that I saw your answer, Martine, I remembered that I have asked about this before, in some other forum, and have got the same answer.  But I didn't remember it.

That is, Travis tricked me again.

If possible, it would be very nice if Travis (and make static-test) was changed so that I won't get tricked again and won't again start doing work which is not needed.

In more precise terms, could the string

  Commit message is longer than 50 characters:

be changed to

 Warning: Commit message is longer than 50 characters (but still < 70 characters):

Had there been at least that one more word, "Warning:", this whole noise would not have taken place.

--Pekka

On 10.10.2018, at 12:50, Ken Bannister <kb2ma at runbox.com<mailto:kb2ma at runbox.com>> wrote:


Martine and I discussed this over a PR a few months ago. The outcome was to update the Good Pull Request wiki page [1], which basically says what has just been discussed on this thread. Good to spread the word and share the link. :-)

Ken

[1] https://github.com/RIOT-OS/RIOT/wiki/Guidelines-for-Creating-a-Good-Pull-Request

On 10/10/2018 03:31 AM, Joakim Nohlgård wrote:
+1 what Martine wrote.

(I was composing a similar message when you beat me to it)
/Joakim

Den ons 10 okt. 2018 08:51Martine Lenders <mail at martine-lenders.eu<mailto:mail at martine-lenders.eu>> skrev:
Hi Pekka,

the 50 chars is just the warning bound. You can go up to 70 until the commit message check fails on you. Longer will make GitHub break the commit message in the webview with the dreaded […] ;-).

My usual approach is to boil down the summary to the bare minimum within these constraints (even using just the module name instead of the full path) and go into details in the following lines of the commit message.

Regards,
Martine

Am Mi., 10. Okt. 2018 um 08:06 Uhr schrieb Nikander Pekka <pekka.nikander at aalto.fi<mailto:pekka.nikander at aalto.fi>>:
[Refactoring the nRF520 mega-PR to follow the standards...]

I guess this has been bashed to death, but I am annoyed.

With long paths, the 50 characters limit on the first line
of the commit message makes it impossible to have any meaningful
explanation of what the commit actually does.  Actually,
the limitation makes the commit messages unintelligible.

_Any_ change of increasing the limit to e.g. 72 characters?

--Pekka

_______________________________________________
devel mailing list
devel at riot-os.org<mailto:devel at riot-os.org>
https://lists.riot-os.org/mailman/listinfo/devel
_______________________________________________
devel mailing list
devel at riot-os.org<mailto:devel at riot-os.org>
https://lists.riot-os.org/mailman/listinfo/devel



_______________________________________________
devel mailing list
devel at riot-os.org<mailto:devel at riot-os.org>
https://lists.riot-os.org/mailman/listinfo/devel


_______________________________________________
devel mailing list
devel at riot-os.org<mailto:devel at riot-os.org>
https://lists.riot-os.org/mailman/listinfo/devel

_______________________________________________
devel mailing list
devel at riot-os.org<mailto:devel at riot-os.org>
https://lists.riot-os.org/mailman/listinfo/devel
_______________________________________________
devel mailing list
devel at riot-os.org
https://lists.riot-os.org/mailman/listinfo/devel

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/devel/attachments/20181010/b94ca5cb/attachment.html>


More information about the devel mailing list