[wdmmg-dev] commit messages and other conventions
friedrich.lindenberg at okfn.org
Sun Mar 20 12:42:38 GMT 2011
On Thu, Mar 17, 2011 at 12:51 PM, Carsten Senger <senger at rehfisch.de> wrote:
> 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.
This is beautiful even now, although we should really find some rules
on what goes into the wiki and what we should put into sphinx: I would
propose leaving the domain model documentation in the wiki as it might
be useful to link it to and from other wiki pages seamlessly, while
"How to write a loader" could go into sphinx?
>> No, though I was mooting the idea of a named branch per ticket as per:
>> 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
I'm not actually convinced that branching development is the better
route to take for a project with the lightweight development process
we still have at OpenSpening: most of the features we implement are
fairly small and can easily live on the default line without impeding
the team's work, while at the same time we don't run into the risk of
merge battles, duplicate work etc. I'd like to propose a convention
where larger, possibly breaking changes live on their own branches,
whereas simple tasks can still go into head.
More information about the openspending-dev