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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
Code repository layout
======================
bin/
Scripts which are going to be installed
doc/
Manual, API reference etc
examples/
Code examples and demonstrations of features in kiwi
kiwi/
Source code goes in here
glade/
Glade files used by kiwi itself
pixmaps/
Pixmaps, images etc
po/
Translations
tests/
Unittests goes in here
tools/
Useful scripts
Contributing
============
Make sure all unittests pass.
If possible, add a new, or modify an existing test after applying a patch.
Feature requests, bug fixes or added features should be submitted through
bugzilla, http://bugs.async.com.br/enter_bug.cgi?product=Kiwi
Always run pyflakes on the whole source code before submitting, it's important
that pyflakes does not show *ANY* warnings at all. Sometimes you have to
add tiny hacks to workaround bugs in pyflakes.
Testsuite
=========
To run the whole testsuite, type:
$ trial tests
in the root directory.
To run a single file, class or test:
$ trial tests.test_datatypes
$ trial tests.test_datatypes.BoolTest
$ trial tests.test_datatypes.BoolTest.testFromString
Coverage
========
Code coverage should generally not increase after checkins, run
the script showcoverage from the tools directory to get a listing of the
current coverage:
$ tools/showcoverage
If you want to see the exact lines, go and dig in _trial_temp/coverage/
It's a little bit broken, so sometimes you have to delete _trial_temp
between runs.
Checklist
=========
To make it easier to get your patch accepted, follow these steps.
* PEP-8 compatible code
* include test
* does the whole testsuite run
* no pyflakes warnings
* if new/modified API:
* add doc strings
* example
* diff -u
* bugzilla
|