vblade/HACKING

Contributions to the vblade are welcome.  

In contributing, though, please stay true to the original simplicity
of the software.  Many open source projects suffer from the "creeping
feature demon" phenomenon.  If you think the vblade needs a great new
feature, first seriously try to think of a way to accomplish your goal
without adding to the vblade itself.

Patches should be clean (to the point and easy to read) and should do
one thing.  Send multiple patches if necessary.  Patches should be
generated with "diff -uprN" if possible, and should be designed to be
applied with "patch -p1".

When possible, the best way to submit a patch is by sending it to the
aoetools-discuss list.  You can subscribe at the aoetools project web
page on sourceforge.net.

When you send your patch, here are some things to cover:

  * What version of the vblade did you use to generate the patch?
    (Hopefully it was the latest.)

  * What was your motivation for creating the patch?  That is, what
    problem does it solve?

  * What testing did you perform to ensure that your patch did not
    introduce bugs and accomplished what you intended?

  * If your changes affect the end-user experience, have you updated
    the vblade documentation?