[wdmmg-dev] commit messages and other conventions

[Carsten Senger]

Hi Rufus

--On Mittwoch, März 16, 2011 21:58:00 +0000 Rufus Pollock
<rufus.pollock at okfn.org> wrote:

> On 16 March 2011 19:56, Carsten Senger <senger at rehfisch.de> wrote:
>> Hi all,
>>
>> I saw that most commit messages are prefixed with [model] or something
>> similar. From the messages I've seen I think the first part is the
>> package or feature worked on, followed sometimes by a marker for the
>> complexity of the changeset (xs, s, m, ...). Is that correct?
>
> That's correct:
>
> [comma,separated,tags][size]
>
> size = xs, s, m, l, xl

that's nice. I'll use it and document it in the "Hacking on Open Spending"
Section

While at it could somebody review the current state of the documentation?
It's sphinx based. If you have sphinx installed in your virtualenv it will
also build the small pieces of api documentation too.
I've restructured INSTALL and README, updated it and put it into /doc
without a deep knowledge about open spending, so there are maybe some
errors and missing information.


>> Are there other conventions I should know of?
>
> No, though I was mooting the idea of a named branch per ticket as per:
>
> <http://trac.ckan.org/wiki/BranchingPolicy>
>
> We haven't mandated this but it could be worth trying this out.

That's a great idea. It's easier to follow and review changes now, find and
understandstand changes later and it will make the default branch more
predictable.

How can we decide to try it out?

..Carsten