Styleguide

This document provides you a styleguide for your Bash code.

Note

This is copied and slightly modified from the Google Styleguide.

tldr;

This document is a brief overview how to structure your bash scripts.

Shell Files and Interpreter Invocation

File Extensions

Environment

STDOUT vs STDERR

Comments

File Header

Formatting

While you should follow the style that's already there for files that

Features and Bugs

ShellCheck

Naming Conventions

Function Names

Calling Commands

Checking Return Values