[Catalyst] Contributing code

Sir Robert Burbridge rburbrid at cisco.com
Mon Jun 21 14:31:12 GMT 2010

On 06/21/2010 10:19 AM, Ævar Arnfjörð Bjarmason wrote:
> On Mon, Jun 21, 2010 at 13:48, Sir Robert Burbridge<rburbrid at cisco.com>  wrote:
>> Out of a discussion last week, I have some code to contribute (largely to
>> Catalyst::Helper).
>> Two quick questions:
>> 1)  I've never contributed code to a project outside my work before.  How do
>> I go about it?
> Have you read http://wiki.catalystframework.org/wiki/contrib ?
I hadn't -- thanks, that's what I needed to find.
>> 2)  I've noticed many times in the CPAN modules I've looked through tend to
>> be very sparsely commented (disregarding POD).  I tend to do a fair bit of
>> inline comments (maybe about 1:2 comments:code).  Is there some reason I
>> should keep comments sparse in contributed code?
> It depends on what sort of comments you're making. Comments that
> explain tricky code that help with maintenance down the road are
> welcome everywhere. If you're just making comments that help someone
> completely unfamiliar with Catalyst to read the code it'll probably be
> more distracting than helpful to core devs.

Hmmm ok.  Tough call.  I tend to explain rationale and ramifications 
more than describe the code.  I'll try to keep everything terse (and I 
don't mind if the comments get removed by cooler heads =)


More information about the Catalyst mailing list