File: CONTRIBUTING

package info (click to toggle)
libthumbor 2.0.2-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 288 kB
  • sloc: python: 900; makefile: 18
file content (33 lines) | stat: -rw-r--r-- 1,225 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
So you want to contribute with libthumbor? Welcome onboard!

There are a few things you'll need in order to properly start hacking on it.

First step is to fork it at http://help.github.com/fork-a-repo/ and create your own clone of libthumbor.

## Dependencies

We seriously advise you to use virtualenv (http://pypi.python.org/pypi/virtualenv) since it will keep your environment clean of libthumbor's dependencies and you can choose when to "turn them on".

You'll also need python >= 2.6 and < 3.0.

After that, just issue a `make setup` command and you'll be ready to start hacking.

## Running the Tests

Running the tests is as easy as:

    make test

## Pull Requests

After hacking and testing your contribution, it is time to make a pull request. Make sure that your code is already integrated with the master branch of libthumbor before asking for a pull request.

To add thumbor's remote as a valid remote for your repository:

    git remote add libthumbor git://github.com/thumbor/libthumbor.git

To merge thumbor's master with your fork:

    git pull libthumbor master

If there was anything to merge, just run your tests again. If they pass, send a pull request (http://help.github.com/send-pull-requests/).