develooper Front page | perl.perl5.porters | Postings from January 2020

request for better commit subject lines

Thread Next
Dave Mitchell
January 14, 2020 17:26
request for better commit subject lines
Message ID:
I don't know whether its got worse since moving to github, but we seem to
have had a spate of commit messages whose first lines give no clue as to
what part of the perl distribution is being modified. To take a typical
example (I'm not naming the author here - its just a random example), the
commit message is:

    Move keywords from a regexp to a qw() list

What keywords are these? Is it discussing a new way for perl's tokenizer
to process source code perhaps? No! Looking at the actual diff, its just
making a test script (t/op/coreamp.t) more readable / greppable.

Please folks, remember (where sensible) to prefix or otherwise decorate
the commit message with some location info, e.g.

    t/op/coreamp.t: Move keywords from a regexp to a qw() list

More examples of good practice (if I may say so myself):

    avoid use-after free in /(?{...})/
    Perl_Slab_Alloc(): tweak logging
    fix leak in APItest.xs
    signatures: add taint tests

That concludes today's grumble.

Never work with children, animals, or actors.

Thread Next Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at | Group listing | About