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 ./setup.py test
  20
  21 - Create a tag for the release
  22 svn copy svn+ssh://<dev>@svn.gentoo.org/var/svnroot/gentoolkit/trunk \
  23          svn+ssh://<dev>@svn.gentoo.org/var/svnroot/gentoolkit/tags/gentoolkit-0.3.0 \
  24          -m "Tagging the <VERSION> release of gentoolkit."
  25 svn update to pull the tag from subversion
  26 cd to the local tags/gentoolkit-0.3.0 directory
  27
  28 - Set the version of the release:
  29 VERSION="0.3.0" ./setup.py set_version
  30
  31 - Create a source distribution (you need to add VERSION here, too):
  32 VERSION="0.3.0" ./setup.py sdist
  33 Transfer dist/gentoolkit-0.3.0.tar.gz to dev.gentoo.org:/space/distfiles-local
  34
  35 - Reset svn version to 'svn' (default):
  36 ./setup.py set_version
  37
  38 - Clean up temporary files:
  39 ./setup.py clean -a
  40