HACKING.txt

Development/testing setup
=========================

Get it from github::

  $ git clone git://github.com/red56/django-immutablemodel.git #or your fork...
  $ cd django-immutablemodel

Set up git flow::

  $ git flow init -d

Create and activate a virtualenv::

  $ virtualenv -p python2.5 --no-site-packages SOMEWHERE
  $ source SOMEWHERE/bin/activate

Install dependencies for development, using virtualenv's pip::

  $ pip install -r requirements.txt

Run the tests::

  $ python runtests.py


Release HOWTO
=============

To make a release, 

  1) git flow release start VERSIONNUMBER
  2) Update release date/version (VERSIONNUMBER) in NEWS.txt and setup.py
  3) Run 'python setup.py sdist'
  4) git flow release finish VERSIONNUMBER && git push && git push --tags 
  5) Upload to PyPI: 'python setup.py sdist register upload'
  6) Increase version in setup.py (for next release -- with dev addition)