Hi! 

On Tue, 11 Aug 2015, Duncan wrote:

> Ryan Hill posted on Mon, 10 Aug 2015 18:17:30 -0600 as excerpted:
> 
> > On Mon, 10 Aug 2015 12:25:58 +0000 (UTC)
> > Duncan <1i5t5.dun...@cox.net> wrote:
> >> What about:
> >> 
> >> * bug number in summary strongly recommended
> > 
> > Making the bug number in the summary manditory or strongly encouraged
> > leads to wonderful commit messages like:
> > 
> > ---
> > cat-pkg: Fix bug #504321.
> 
> Ideally, it'd be something a bit more informative (here taking Gordon's 
> points about the previously suggested B#):
> 
> cat-egory/semi-long-package-name: fix amd64-fbsd build error G-504321
> 
> > I would like to see this be more common:
> > 
> > ---
> > cat-pkg: Make the thingy work again
> > 
> > Gentoo-Bug: https://bugs.gentoo.org/504321 *(or 504321 Idon'tcarewhich)
> > ----
> > 
> > If we're limiting the summary to 1 line, 70-75 chars, manditory
> > cat/package and bug number there's not a lot of room to summarize in.
> 
> Note that a bug number would fit in your above summary very easily, 
> omitting nothing, as it's only ~35/75 length.
> 
> Even with my somewhat longer cat/pkg example with the longest arch-
> keyword I could quickly find, there's still room to indicate at minimum 
> build vs runtime error, with the gentoo bug number reference for anyone 
> who might find it interesting enough to look further than the one-line.  
> People can then either select and klipper-popup (adding my usual trigger 
> method to the others people have mentioned), or read the longer 
> description for the full bug URL to click, if they prefer.

The more we stuff into the summary line, the harder it will be to
write meaningful summaries. And thus, people will write crappy
ones or ignore the length limit. I recommend against any more
prescription over "Add the the cat/pn if meaningful, don't use
more than 75 characters".

The cat/pn rule is tricky anyway: what if one commit touches 100
packages? Or should that be split into 100 commits for easier
partial rollback?

Regards,
Tobias

-- 
Sent from aboard the Culture ship
        Fine Till You Came Along

Reply via email to