Ruby Development Style Guide

Use snake_case for variable and method names.

Use CamelCase for class and module names.

Use SCREAMING_SNAKE_CASE for constants.

Use descriptive names that convey the purpose of the variable, method, or class.

Avoid abbreviations unless they are widely understood.

Use verbs for method names to indicate actions.

Use nouns for class and module names to indicate entities.

Use classes and class instance methods for objects that work like objects — they have state and do not act on other objects' state.

Use module methods acting on objects or carrying out general operations/utility functions.

Use Rake for internal (developer) CLI; use Thor for user-facing CLI

Gems may begin life as a module within another gem.

Use lib/ for main application code.

Use spec/ for specifications and tests.

Use docs/ or _docs/ for documentation.

Use build/ for pre-runtime artifacts.

Use _build/ as default in applications that generate files at runtime, unless another path is more appropriate (ex: _site/ in Jekyll-centric apps).

Do NOT assume or insist upon perfect alignment with Ruby path conventions:

Use 2 spaces for indentation.

Limit lines to 120 characters or so when possible.

Use parentheses for method calls with arguments, but omit them for methods without arguments.

Do not use parentheses in method definitions (def method_name arg1, arg2).

Use single quotes for strings that do not require interpolation or special symbols.

Use double quotes for strings that require interpolation or special symbols.