Skip to content

Latest commit

 

History

History
33 lines (28 loc) · 1.17 KB

HACKING.md

File metadata and controls

33 lines (28 loc) · 1.17 KB

Hacking

Instructions for collaboration:

Write code that you think is good/clean and make a descriptive pull request. See open issues and projects for ideas on what to add. A functional, metric-terse style is generally prefered: ten lines per function, ten functions per module, etc. Try to write with 80-columns.

When in doubt:

The Zen of Python, by Tim Peters

Beautiful is better than ugly.
Explicit is better than implicit.
Simple is better than complex.
Complex is better than complicated.
Flat is better than nested.
Sparse is better than dense.
Readability counts.
Special cases aren't special enough to break the rules.
Although practicality beats purity.
Errors should never pass silently.
Unless explicitly silenced.
In the face of ambiguity, refuse the temptation to guess.
There should be one-- and preferably only one --obvious way to do it.
Although that way may not be obvious at first unless you're Dutch.
Now is better than never.
Although never is often better than *right* now.
If the implementation is hard to explain, it's a bad idea.
If the implementation is easy to explain, it may be a good idea.
Namespaces are one honking great idea -- let's do more of those!