adphi/oh-my-zsh
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Formatted with markdownfmt

CoolOppo 2014-10-04 12:26:40 -07:00
parent 9c85763de6
commit 19a8329bfe
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Coding-style-guide.md

@ -1,4 +1,5 @@
## Variables Variables
---------
Meaningful self documenting names should be used, if the variable name does not make it reasonably obvious as to the meaning, appropriate comments should be added. Meaningful self documenting names should be used, if the variable name does not make it reasonably obvious as to the meaning, appropriate comments should be added.
@ -8,8 +9,8 @@ Preferred naming convention is to use `snake_case` names, and not `CamelCase` or
Variables name should not clobber command names, such as `dir`, `pwd` Variables name should not clobber command names, such as `dir`, `pwd`
Functions
## Functions ---------
Braces should be on the same line as the function name: Braces should be on the same line as the function name:
@ -27,8 +28,8 @@ function _helper-util() {
} }
``` ```
General
## General -------
Indenting should be done with 2 spaces. Indenting should be done with 2 spaces.
@ -45,4 +46,4 @@ $PWD # do use
if [[ -f $1 ]]; then if [[ -f $1 ]]; then
... ...
fi fi
``` ```