Skip to content

Latest commit

 

History

History
29 lines (21 loc) · 808 Bytes

coding-style.md

File metadata and controls

29 lines (21 loc) · 808 Bytes
Raw

Coding and Commit Style Guide

Coding Style

In general, code should follow the style guide established in the individual files. Below are some guidelines for each individual language.

Python

  • Python code should use spaces for indentation.
  • The indentation level should be 4 spaces.
  • Code should be formatted using autopep8 as the Python formatter.

Shell

  • Shell scripts should use bash as the shell.
  • Indentations should be 4 spaces.
  • All variables should be ${name}.
  • Shell functions should use the function keyword.

Commit Messages

Commit messages should follow the format outlined below:

Single line short descriptions

Long description explaining the changes. This should
explain the motivation behind the changes, not what changed.
Think "Why?", not "What?"