Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

18 lines (13 loc) · 1.08 KB

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.
  • Commit messages should be formatted using AngularJS conventions (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.