Skip to content
jamis edited this page Sep 13, 2010 · 4 revisions

Firstly, BucketWise is (and always will be) highly opinionated. While I welcome all comers to look at the code and hack away, I have no intention of accepting all patches that are sent. In order to maximize the likelihood that your patch is accepted:

  • Make it a small patch. The larger the patch, the longer it’ll take me to review it, and the less likely it’ll get applied.
  • Clearly explain why the patch is necessary (or otherwise desirable).
  • Include tests! The code, as it is, is not as robustly tested as I would like, but even so, I will not accept any but the most trivial patches unless they come with tests (or otherwise have a really good reason for lacking tests).
  • Make sure your patch applies cleanly against my master branch. If I go to apply a patch and it doesn’t apply cleanly, I won’t bother trying to fix it.

Bug fixes are much more likely to be applied than new features, but features that are listed in the TODO file are those that I’m personally interested in seeing land eventually. That said: if I don’t like something about an implementation that is sent to me, I’m not going to be afraid to tell you so.

Sorry to be so hard-nosed. It’s just that I’m using this code to manage my own personal finances, and I’d really hate for someone’s patch to mess up my data. :)

Still interested in contributing? Awesome! Let the patches roll.

API

If you’re interested in writing software that interacts with BucketWise, you’ll be happy to know that BucketWise supports a basic REST API. You can read about it in docs/API.rdoc.

License

The license for BucketWise is the most unrestricted license available: the code, in its entirety, is hereby placed in the public domain. What does this mean? It means you can do anything you like with the sources for BucketWise. Anything. You can sell it if you want. You can hack on it and release your changes under a different product name, using a totally different license. I’m serious. We’ll see how it all works!

Ideally, people will contribute back to me, but as I said above, I’m going to be extremely opinionated, and maybe that’ll turn some people off. I would still like to see what those people do with BucketWise, though, so hopefully a public domain license will prevent inspiration from dying.

Clone this wiki locally