On Wed, Sep 22, 2010 at 1:36 PM, Markus Roberts <[email protected]> wrote:
>> I would rather just have a simple ticket notation without a loaded
>> preceding word like fix.
>
> What you call "loaded" I would call "informative"; there's a
> difference between a "Fix", a "Partial fix" and a "Minimal fix" etc.
> and it's nice to see that distinction in the one-line lists, change
> logs, subject lines, etc.

I agree it's informative, I'd just rather see it after the ticket
number in the rest of the commit message.  And then I'd rather it said
something like "Fixes parser error..." since that tells me more than
it fixed ticket number #1234.

> As a general rule, I'm against scripting
> such things; scripts are great for _extracting_ information but they
> tend to go awry when they are expected to _inject_ information.  Is
> the amount of typing it saves really that significant?

It's not the amount of typing, it's so that I don't forget to include
the ticket number in my commit message as all too often happens.
Plus, it is a pain for me to have to remember the number of the ticket
I'm working on.  It's not that typing a 4 digit number is a lot of
typing, it's that I have to stop what I'm writing in the commit
message and go look elsewhere for the number of the ticket I'm working
on, which is already in my branch name.  This has been a very useful
thing to script for me.

> "Fixing/Partial fix for" and friends has been (and still is, so far as
> I'm aware) the convention for the project.
If that's what is convention I was never made aware of it.  I even
submitted my git hooks for automating the ticket number in the commit
message to the mailing list and nobody every said anything.

Whatever we decide I'll abide by it as long as it's written down
somewhere.  The current developer lifecycle documentation
(http://projects.puppetlabs.com/projects/puppet/wiki/Development_Development_Lifecycle)
doesn't say exactly what a commit message should look like, just that
it should include the ticket number.  It also mistakenly says you can
automatically close tickets by using some keywords in front of the
ticket number.  I think that's where the convention for preceding the
commit number with keywords comes from.  I'll update the wiki once we
decide on a commit message standard.

-- 
You received this message because you are subscribed to the Google Groups 
"Puppet Developers" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/puppet-dev?hl=en.

Reply via email to