Skip to content

Style Guide

Jump to bottom
daftpwner edited this page Jan 23, 2018 · 1 revision

Style Guides

Git Flow

This project will attempt to follow the Git branching model, Git Flow, developed by Vincent Driessen. This model can be read about in this blog post.

Code Formatting

  • Spaces instead of tabs (4 spaces to a tab, check your ide for an option to perform automatic conversion)
  • Variables are camelCase
  • Classes are PascalCase
  • Functions are lowercase_with_underscores
  • Constants are UPPERCASE_WITH_UNDERSCORES
  • Be sure to use full, meaningful names. Don't abbreviate if it introduces any uncertainty!
  • Python will loosely follow PEP 8. See here for full PEP 8 standards. (many ide's have support/plugins for PEP 8)

Clone this wiki locally