Skip to content

Procedure

Helzibah edited this page Apr 4, 2012 · 29 revisions

Procedure

Initial Setup

  • Fork this repository to create your own copy.
  • Install the python headers, usually in a python-dev package in your package manager.
  • Set up a virtual environment
    • With virtualenv:
      virtualenv -p $(which python2) ~/path/csbot
      cd ~/path/csbot
      git clone [email protected]: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 [email protected]:YOURUSERNAME/csbot.git src
      pip install -r src/pip_requirements.txt

Code

  • 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
  • Read the API documentation.
  • See the Plugins page for plugin details, including conventions.

Distribute

  • Recommended reading: GitHub Flow
  • Always fetch and merge upstream changes first. Then issue a pull request to csyork/csbot:master.
Clone this wiki locally