Contributing to Restfulie py

Making Your Changes

The first thing you need to do is obtain a clone of the repository

$ git clone git://github.com/caelum/restfulie-py.git
$ cd restfulie-py
Then you need to create your new branch:
$ git checkout -b my-contribution
Switched to a new branch "my-contribution"

Now you’re ready to get hacking. Be sure to include tests which demonstrate the bug you’re fixing, and fully exercise any new features you’re adding. You should also take care to make sure the documentation is updated if you’re changing the API. This includes updating API docs and guides. Once you’ve finished making your changes, open a ticket in the "Restfulie Lighthouse:http://restfulie.lighthouseapp.com/projects/62572-restfulie-py/tickets describing the changes you’ve made.

Next, commit your changes, making sure to add the proper ticket update keyword so that when your patch is merged, the lighthouse ticket is updated.

Let’s pretend our ticket number for doing “my-contribution” is #1337. We’ll commit to the local branch like this:

$ git commit -a -m "I did my-contribution by supporting a new media type, opensearch [#1337 state:resolved]"
Created commit 29f8baa: I did my-contribution by supporting a new media type, opensearch
 1 files changed, 0 insertions(+), 1 deletions(-)

Send an email to restfulie-dev mailing list or send us a pull request through github.

Congratulations and Thank You!

Once your changes have been applied, you’ve officially become part of community of independent contributors working to improve Restfulie-py.

(this description was partially taken from rails default process)