How to contribute

March 12, 2009

As part of the attempt to get more organized, this post outlines how to contribute to Dumbo. I might turn this into a wiki page eventually, but a blog post will probably get more attention, and people who are not planning to contribute to Dumbo any time soon might still be interested in the process described in the remainder of this post.

If you haven’t done so already, create a GitHub account and fork the master tree. Then go through the following steps:

  1. Either create a new ticket for the changes you have in mind, or add a comment to the corresponding existing ticket to inform everyone that you started working on it.
  2. Make the necessary changes (and add unit tests for them).
  3. Run all unit tests:

    $ python test
  4. If none of the tests fail, commit your changes using a commit message that GitHub’s issue tracker understands:

    $ git commit -a -m "Closes GH-<ticket number>"
  5. Push your commit to GitHub:

    $ git push
  6. Send a pull request to me.

If you want to be able to easily get back to it later, you can also create a separate branch for the ticket and push this branch to GitHub instead. This might, for instance, save you some time when I spot a bug in your changes, and ask you to send another pull request after fixing this bug.