Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
47 lines (29 sloc) 1.4 KB

Contributing

  1. Fork it.
  2. Clone it

create a virtualenv

$ virtualenv env              # Create virtual environment
$ source env/bin/activate     # Change default python to virtual one
(env)$ git clone https://github.com/tasdikrahman/spammy.git
(env)$ cd spammy
(env)$ pip install -r requirements.txt  # Install requirements for 'spammy' in virtual environment

Or, if virtualenv is not installed on your system:

$ wget https://raw.github.com/pypa/virtualenv/master/virtualenv.py
$ python virtualenv.py env    # Create virtual environment
$ source env/bin/activate     # Change default python to virtual one
(env)$ git clone https://github.com/tasdikrahman/spammy.git
(env)$ cd spammy
(env)$ pip install -r requirements.txt  # Install requirements for 'spammy' in virtual environment
  1. Create your feature branch ($ git checkout -b my-new-awesome-feature)
  2. Commit your changes ($ git commit -am 'Added <xyz> feature')
  3. Run tests

nosetests is being used as the testing suite. To run the tests

(env) $ nosetests

Conform to PEP8 and if everything is running fine, integrate your feature

  1. Push to the branch ($ git push origin my-new-awesome-feature)
  2. Create new Pull Request

Hack away!