README.dev

   1 Adding or modifying code:
   2 =========================
   3 - If you add new code, best practice is to write a test for it.
   4 - If you're modifying code that doesn't have a test and you can write a test
   5   for it, please do.
   6 - Before committing your changes to a python file, please make sure it passes
   7   pylint with:
   8 pylint --rcfile=pylintrc yourfile.py
   9 - If pylint raises a warning or error that you don't agree with, it's probably
  10   better to just change your code. If you're sure you have a good reason for
  11   doing what you're doing, you can add an exception to our pylintrc.
  12
  13 Creating a release:
  14 ===================
  15 Note: We are using VERSION="0.3.0" simply as an example.
  16
  17 - Run Gentoolkit's test suite, make sure it passes:
  18 Note: requires dev-python/snakeoil
  19
  20 Note: If running from the gentoolkit repository, please grab the eclean test file from:
  21 http://genscripts.googlecode.com/svn/trunk/gentoolkit/pym/gentoolkit/test/eclean/testdistfiles.tar.gz
  22 Please do not add/commit the test file to the gentoolkit repository
  23
  24 ./setup.py test
  25
  26 - Create a tag for the release
  27 svn copy svn+ssh://<dev>@svn.gentoo.org/var/svnroot/gentoolkit/trunk/gentoolkit \
  28          svn+ssh://<dev>@svn.gentoo.org/var/svnroot/gentoolkit/tags/gentoolkit-0.3.0 \
  29          -m "Tagging the <VERSION> release of gentoolkit."
  30 svn update to pull the tag from subversion
  31 cd to the local tags/gentoolkit-0.3.0 directory
  32
  33 - Create a source distribution (you need to add VERSION here):
  34 VERSION="0.3.0" ./setup.py sdist
  35 Transfer dist/gentoolkit-0.3.0.tar.gz to dev.gentoo.org:/space/distfiles-local
  36
  37 - Clean up temporary files:
  38 ./setup.py clean -a
  39