forked from smartpm/smart
-
Notifications
You must be signed in to change notification settings - Fork 0
/
HACKING
23 lines (19 loc) · 805 Bytes
/
HACKING
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Code Conventions
----------------
- Classes must be new-style, and named LikeThis.
- Functions and methods are named likeThis().
- Variables and attributes are named likethis.
- Private and protected attributes are named _likethis.
- Private methods where name clashing with subclasses is probable
(e.g. Progress) are named __likethis.
- Identation is 4 expanded spaces.
- Lines must have at most 79 columns.
- Follow PEP-8 whenever it doesn't conflict with the statements above.
- Space comparisons >= like == this, but parameters like=this.
- Methods/function calls have parameters(spaced, like, this), even
if they((have, additional, parenthesis)).
Testing
-------
- For every change, try to create a new test.
- Run all tests: 'make test'.
- Run specific test: 'TEST=tests/test.txt make test'