Recipe for committing contributions

[Oy...@Sun.COM]

The attached html file contains a recipe/checklist that I find useful 
when committing patches. I was just wondering if this is something that 
you other guys would find useful as well. If so, we could perhaps make 
it a Wiki page or publish it in some other way. You may not agree on 
everything, or there may be some issues I haven't though of; feel free 
to comment on that. The intention of the document is to make sure that 
things go smoothly and you don't break the build.

-- 
Oyvind Bakksjo
Sun Microsystems, Database Technology Group
Trondheim, Norway
http://weblogs.java.net/blog/bakksjo/

Re: Recipe for committing contributions

["Jean T. Anderson" <jt...@bristowhill.com>]

Oyvind.Bakksjo@Sun.COM wrote:
> The attached html file contains a recipe/checklist that I find useful 
> when committing patches. I was just wondering if this is something that 
> you other guys would find useful as well. If so, we could perhaps make 
> it a Wiki page or publish it in some other way. You may not agree on 
> everything, or there may be some issues I haven't though of; feel free 
> to comment on that. The intention of the document is to make sure that 
> things go smoothly and you don't break the build.

One clarification that might be useful is that this is for committing 
patches to the code tree.

Once up on the Wiki, I might add a link to the doc tree DITA 
instructions at 
http://db.apache.org/derby/manuals/dita.html#Submitting+documentation+patches 
(if Jeff doesn't beat me to it).

  -jean

Re: Recipe for committing contributions

[Daniel John Debrunner <dj...@debrunners.com>]

Jean T. Anderson wrote:

> Oyvind.Bakksjo@Sun.COM wrote:
> 
>> The attached html file contains a recipe/checklist that I find useful
>> when committing patches. I was just wondering if this is something
>> that you other guys would find useful as well. If so, we could perhaps
>> make it a Wiki page or publish it in some other way. You may not agree
>> on everything, or there may be some issues I haven't though of; feel
>> free to comment on that. The intention of the document is to make sure
>> that things go smoothly and you don't break the build.
> 
> 
> I'd like to see a Wiki page with this information. Currently there's
> also a somewhat shorter recipe at
> http://db.apache.org/derby/derby_comm.html#Contribute+Code+or+Documentation
> . That section could point to the Wiki page.
> 
> The reason I'd rather it be on the Wiki (and not on the web site) is it
> makes it easier for committers and contributors to directly correct and
> improve that information.

A wiki page is good, since this is really an example of how to apply a
patch, not any official way.

Eg. I use Eclipse to apply patches as it always works for me, whereas
the patch command sometimes rejects valid patches. However using Eclipse
should not b a requirement.

And I personally don't see the value in applying the patch at the
original revision, but if it works for folks that's fine.

Dan.

Re: Recipe for committing contributions

["Jean T. Anderson" <jt...@bristowhill.com>]

Oyvind.Bakksjo@Sun.COM wrote:
> The attached html file contains a recipe/checklist that I find useful 
> when committing patches. I was just wondering if this is something that 
> you other guys would find useful as well. If so, we could perhaps make 
> it a Wiki page or publish it in some other way. You may not agree on 
> everything, or there may be some issues I haven't though of; feel free 
> to comment on that. The intention of the document is to make sure that 
> things go smoothly and you don't break the build.

I'd like to see a Wiki page with this information. Currently there's 
also a somewhat shorter recipe at 
http://db.apache.org/derby/derby_comm.html#Contribute+Code+or+Documentation 
. That section could point to the Wiki page.

The reason I'd rather it be on the Wiki (and not on the web site) is it 
makes it easier for committers and contributors to directly correct and 
improve that information.

   -jean