README.dev


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

Adding or modifying code:
=========================
- If you add new code, best practice is to write a test for it.
- If you're modifying code that doesn't have a test and you can write a test
  for it, please do.
- Before committing your changes to a python file, please make sure it passes
  pylint with:
pylint --rcfile=pylintrc yourfile.py
- If pylint raises a warning or error that you don't agree with, it's probably
  better to just change your code. If you're sure you have a good reason for
  doing what you're doing, you can add an exception to our pylintrc.

Creating a release:
===================
Note: We are using VERSION="0.3.0" simply as an example.

- Run Gentoolkit's test suite, make sure it passes:
Note: requires dev-python/snakeoil

./setup.py test

- Create a source distribution (you need to add VERSION here):
VERSION="0.3.0" ./setup.py sdist
Transfer dist/gentoolkit-0.3.0.tar.gz to dev.gentoo.org:/space/distfiles-local

- Clean up temporary files:
./setup.py clean -a
git status
rm or mv any untracked files/directories

- Create a tag for the release
git tag gentoolkit-0.3.0
git push origin gentoolkit-0.3.0