From 19d11ab1d057544d67a0c12172cbf28291bcc62d Mon Sep 17 00:00:00 2001 From: Kaleb Elwert Date: Sat, 15 Apr 2017 01:14:09 -0700 Subject: [PATCH] Add code style to CONTRIBUTING.md Closes #1296 --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eec4c16..79d23f1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,6 +23,17 @@ improve its performance, do not hesitate to fork and send pull requests. - Open a [pull request][4] that relates to but one subject with a clear title and description in grammatically correct, complete sentences. +#### Code Style + + - Indent using 2 spaces. No tabs. + - Put `; do` and `; then` on the same line as the `while`, `for` or `if`. + - Local variables should be used whenever possible. + - Use `snake_case` for variable and function naming. + - Local variables should be lower cased. + - Global variables should be upper cased. + - Use `$(command)` instead of backticks. + - Avoid `eval` if possible. + #### Modules - A *README.md* must be present.