Syntax Guide

Every major open-source project has its own style guide: a set of conventions (sometimes arbitrary) about how to write code for that project. It is much easier to understand a large codebase when all the code in it is in a consistent style.

“Style” covers a lot of ground, from “use camelCase for variable names” to “never use global variables” to “never use exceptions.” This page links to the style guidelines I use for my project. If you are modifying a project that originated from me, you may be pointed to this page to see the style guides that apply to that project.

For now, style guides are defined for:

• Shell Scripts
• Documentation Guide