953e077e53
This patch makes some style rules explicit by listing them in CONTRIBUTING.md and fixes one case in which the style rules were violated.
19 lines
1.1 KiB
Markdown
19 lines
1.1 KiB
Markdown
### Contributing ###
|
|
|
|
Kurt Griffiths (kgriffs) is the creator and current maintainer of the Falcon framework. Pull requests are always welcome.
|
|
|
|
Before submitting a pull request, please ensure you have added/updated the appropriate tests (and that all existing tests still pass with your changes), and that your coding style follows PEP 8 and doesn't cause pyflakes to complain.
|
|
|
|
#### Additional style rules ####
|
|
|
|
* Comments follow [Google's style guide][goog-style-comments].
|
|
* Commit messages should be formatted using [AngularJS conventions][ajs] (one-liners are OK for now but body and footer may be required as the project matures).
|
|
* When catching exceptions, name the variable `ex`.
|
|
* Use whitespace to separate logical blocks of code and to improve readability.
|
|
* No single-character variable names except for trivial indexes when looping,
|
|
or in mathematical expressions implementing well-known formulas.
|
|
* Heavily document code that is especially complex and/or clever.
|
|
|
|
[ajs]: http://goo.gl/QpbS7
|
|
[goog-style-comments]: http://google-styleguide.googlecode.com/svn/trunk/pyguide.html#Comments
|