[ckan-dev] git branching

[Rufus Pollock]

On 22 December 2011 11:14, David Read <david.read at okfn.org> wrote:
> On 22 December 2011 10:01, Rufus Pollock <rufus.pollock at okfn.org> wrote:
>> I use the 'standard':
>>
>> fixes #{ticket-num}
>> refs #{ticket-num}
>>
>> (many systems have hooks for using these references in commit messages)
>
> I'd much prefer this in a 'header' at the start of the comment.
> Otherwise it is hard to find and easier to forget to include. And
> since we don't use any of these 'standard' systems there is no
> benefit.
>
> David and Ross have also given support for putting in the ticket number.

I agree and have started using [#{ticket-num},model] or similar in
commits (I like have the # as a) standard systems (such as github
tickets, and trac if configured) pick up on these b) it makes it
easier to distinguish from some other number.

> I found myself benefiting from the [model] type tags today.

:-) (I like the size tags but feel these are optional -- i find them
useful because it helps me look for a big commit).

> So how about this sort of thing:
>
> [1502][tests,doc] Finished tests and added an example usage in the doc.

I like this but why not just do:

[#1502,test,doc]

(and allow optional size for people who want it e.g. [#1502,test,doc][xs]: ...)

Rufus

> Dave
>
>>
>> Rufus
>>
>> On 21 December 2011 17:52, John Glover <john.glover at okfn.org> wrote:
>>> Ticket number in the commit message is fine by me. I'm not sure that
>>> there's any real value in the size tags, but I find that labelling
>>> which areas are changed is quite helpful when scanning through a list
>>> of commits.
>>>
>>> Cheers,
>>> John
>>>
>>> On 21 December 2011 12:19, David Read <david.read at okfn.org> wrote:
>>>> We are all careful to commit code to branches named after the ticket,
>>>> which is great. But looking at the git logs, I'm struggling to find
>>>> out what branches things were on. Just browsing
>>>> https://github.com/okfn/ckan/network in busy periods like 2-7 November
>>>> or 1-5 December and it really is a pretty undecipherable.
>>>>
>>>> So, I'd like to propose that every commit includes the ticket number
>>>> in the comment, even when on a branch.
>>>> e.g.
>>>> [1502] Finished tests and added doc
>>>>
>>>> What do people think?
>>>>
>>>> Also, Rufus originally suggested other conventions for the commit messages:
>>>> * [l][s][xs] meaning large, small, extra small - referring to the size
>>>> of the diff
>>>> * [lib,template,tests] meaning changes have occurred principly in the
>>>> lib, template and tests directories
>>>> Some people have tried these and they remain undocumented. Does anyone
>>>> find them useful or shall we drop them, saving our efforts for the
>>>> ticket number?
>>>>
>>>> David
>>>>
>>>> _______________________________________________
>>>> ckan-dev mailing list
>>>> ckan-dev at lists.okfn.org
>>>> http://lists.okfn.org/mailman/listinfo/ckan-dev
>>>
>>> _______________________________________________
>>> ckan-dev mailing list
>>> ckan-dev at lists.okfn.org
>>> http://lists.okfn.org/mailman/listinfo/ckan-dev
>>
>>
>>
>> --
>> Co-Founder, Open Knowledge Foundation
>> Promoting Open Knowledge in a Digital Age
>> http://www.okfn.org/ - http://blog.okfn.org/
>>
>> _______________________________________________
>> ckan-dev mailing list
>> ckan-dev at lists.okfn.org
>> http://lists.okfn.org/mailman/listinfo/ckan-dev



-- 
Co-Founder, Open Knowledge Foundation
Promoting Open Knowledge in a Digital Age
http://www.okfn.org/ - http://blog.okfn.org/