[Koha-devel] Guidelines for Patch Acceptance/Rejection

Galen Charlton gmcharlt at gmail.com
Thu Nov 11 13:50:26 CET 2010


Hi,

On Thu, Nov 11, 2010 at 4:11 AM, Colin Campbell
<colin.campbell at ptfs-europe.com> wrote:
> It is worth stressing that there are things which will encourage quick
> adoption of a patch.
> Good commit messages, tests that prove it does what it says and doesn't
> add needlessly to the amount of entropy in the universe.

Here are other characteristics of a good patch:

[1] The patch covers a single topic.

For example, a patch that fixes a circulation bug and adds a new
cataloging feature is problematic; if the circ bugfix works but the
new cataloging feature doesn't, the patch can't be accepted as is.
Also, such a patch is more difficult to test; somebody who is an
expert in Koha's circulation module may not be comfortable signing off
on a cataloging enhancement.

[2] The patch is easy to read.

In particular, please don't mix up major whitespace correction and
functionality.  If you want to clean up whitespace, please do so in a
separate patch.

[3] The patch does not contain the detritus of your coding process.

In other words, the patch shouldn't contain things like unguarded
warns left over from your debugging or temporary files.

Regards,

Galen
-- 
Galen Charlton
gmcharlt at gmail.com


More information about the Koha-devel mailing list