Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

Latest commit

 

History

History
60 lines (41 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

60 lines (41 loc) · 1.41 KB

Contributing

This project is still a work in progress. Feel free to make a PR

  • Fork it.

  • Clone it

create a virtualenv

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

Or, if virtualenv is not installed on your system:

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

  • Make sure that your code Conforms to PEP8 and if everything is running fine, integrate your feature

  • Running the tests

Plino uses nosetests to run its test suite. To run them

$ nosetests # inside the parent directory
  • Push to the branch
$ git push origin my-new-awesome-feature

Hack away! 😄