-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Heyo!

I think we have a task to formally document this, but in the meantime
I wanted to send out a quick note about a Redmine feature I've noticed
that we're missing out on so far, that I think is pretty neat.

There are three special keywords you can add in your commit message
that Redmine will take note of and perform one of two actions (closes
and fixes are synonyms). Here are example usages for an issue numbered 99:

closes #99
fixes #99
re #99

If you include this special message in your commit message, Redmine
will add a special block on your ticket that shows all commits that
were made against that issue. Each commit is a link that you can click
on to see the diff, and other information. It's pretty useful when you
want to find out what fixed an issue in hindsight. All three of these
keywords will add the commit to the ticket. closes and fixes will
additionally change the ticket's state to modified, and also advance
the ticket's completion to 100%. For an example of what I mean, see
#686[0], under "Associated revisions" on the right under the
description. You will need to be logged in to see it, I believe.

You don't have to have this in your commit message subject, and I
would suggest that it is best not to. Commit message subjects are
supposed to be very short, and so I'd prefer that we save those
precious chars for a more descriptive subject. I prefer to put these
special keywords on their own line, as the end of my commit message.

For example, my commit message on #686 is this:

> Upstart use stop/start instead of restart_workers.
> 
> This commit updates our Upstart init scripts to call stop_workers
> and then start_workers, instead of restart_workers(). There seems
> to be an issue with Celery multi, restarting, and Pulp. This commit
> works around that issue by fully stopping the workers instead of
> issuing a restart to them.
> 
> https://pulp.plan.io/issues/686
> 
> closes #686

[0] https://pulp.plan.io/issues/686

- -- 
Randy Barlow
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQIcBAEBCgAGBQJVC1/+AAoJEIyFaKUJtmpiIoUP/3t7Ks/q30Q0CczD7TStAEpB
TH7S6gzSZ+nP+gzMIgBXhUh9frRHbHLGFDv7e7dso6cr/oFGbgaMjAF8tJ85CJYe
WLNo4mbYA54caZo7tqenQsDG2lDBNCNV5RrMQd2iwCzncwb36fOSpaNdEqk7C6yF
3bh0ZMoKJA3f4yMkjDjNb9noEPYdHCP+4gEn0CLb+T7aepXmREL0XBpLwBYDP3+z
kVYsfV6HucCeJZTiz5lCzGHBEshyah5VEcCJH+7hmwWg7LeihKk5EMwvcx777X2v
129CoQICP7x05S9RrmcT+03SB8LCoOd86Ofw9yXb2jxUjqBIfJ3GQL4WMEP8Tgc8
SpeUKUWF5SlyoJTWLesY3KXgpboXYmU+m/NjsnkLTjs95R9s7xarSgMy7ZjT93gO
HNMALIbivkWFE76evstHDMErQUtgRg7tmuTCbkkL6Pd/DuNYnlNCWp5rWvw+YTBR
oSzbv2mAMQCRvmSaPvv93FXVLgJjeGe0avuMYYxa/8YH1zFlFxsbpNKLgxZJTGjA
mUx0pNV4a0Davr8HLaV9EzAvXHpeqEBf6/SFihSkUWODSeR8/1NwvxJH4bc/zD/4
U4Unc5VHnMqhsHlacTLjyB7F2ajpmk3eApiVsT+1kpPJ5ZKfP7+kUJZNG2GIYvoK
g7FOcTQoC7VbBubJQcO8
=vtCe
-----END PGP SIGNATURE-----

_______________________________________________
Pulp-list mailing list
Pulp-list@redhat.com
https://www.redhat.com/mailman/listinfo/pulp-list

Reply via email to