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

Re: request for better commit subject lines

Thread Previous | Thread Next
Karl Williamson
January 14, 2020 21:58
Re: request for better commit subject lines
Message ID:
On 1/14/20 10:26 AM, Dave Mitchell wrote:
> 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

I'm with Dave on this one.  A commit subject message should be like a 
newspaper headline (and not one of those sensationalist papers either)

To save space, I just start my commit with foo: where "foo" is a 
function, or feature, or even a file.  I think something like

toke.c: Fix typo in comment

is sufficient.  But 'toke.c: Fix bug' isn't.  That would be better to 
have the function before the colon, and a little about the bug afterward

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