-
Notifications
You must be signed in to change notification settings - Fork 31
/
HACKING
31 lines (17 loc) · 872 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
24
25
26
27
28
29
30
31
Conventions to follow while hacking:
1. API should return data, not text
2. functions or methods which print to stdout should be named with a
prefix of cli_ and should only be used when invoked via the CLI. Pure
API calls should not print to stdout.
3. Two blank lines after every function and method
4. Separate blocks of ideas within a function with a single blank line
5. flake8 (as configured in setup.cfg) otherwise
6. imports at the module level unless doing something tricky. Use
relative imports as appropriate
7. don't over-nest function calls. don't be afraid to use a local
variable to hold data between steps. It can be much clearer to read
later
8. delete-trailing-whitespace or whatever it's called in your editor
9. Run `tox` and fix any unexpected issues before committing.
10. Add yourself to AUTHORS and your change to ChangeLog
# The end.