Procedure

Initial Setup

• Fork this repository to create your own copy.
• Set up a virtual environment

  • With virtualenv:

    virtualenv -p $(which python2) ~/path/csbot
    cd ~/path/csbot
    git clone git@github.com:YOURUSERNAME/csbot.git src
    pip install -r src/pip_requirements.txt

  • Or with virtualenvwrapper: (remember to add WORKON_HOME=~/PYTHONENVS to .bashrc)

    export WORKON_HOME=~/PYTHONENVS mkvirtualenv -p $(which python2) csbot cd $WORKON_HOME/csbot git clone git@github.com:YOURUSERNAME/csbot.git src pip install -r src/pip_requirements.txt`

Coding

• Branch early, branch often!
• Commit early, commit often! With sensible commit messages!
• Follow PEP 8 Style Guide for all Python code. Highlights:
  • 4 spaces for indentation
  • 'lower_case' for modules, functions, variables
  • 'CamelCase' for classes and exceptions
  • 'CAPITAL_LETTERS' for constants

Distribute

• Recommended reading: GitHub Flow
• Issue a pull request to csyork/csbot:master