From 22a43204fc2b52be6312b10b8154ac415439e629 Mon Sep 17 00:00:00 2001 From: Dylan Araps Date: Fri, 4 May 2018 17:51:53 +1000 Subject: [PATCH] docs: update --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cf35decc..5d3aaf56 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,6 +15,9 @@ ## Coding Conventions +- Use `bash` built-ins wherever possible. +- Try not to pipe (`|`) at all. +- Limit usage of external commands `$(cmd)`. - Indent 4 spaces. - Use [snake_case](https://en.wikipedia.org/wiki/Snake_case) for function and variable names. @@ -42,6 +45,10 @@ request on the repo and our Travis.ci hook will run ShellCheck for you. ### No no's +- Don’t use GNU conventions in commands. + - Use POSIX arguments and flags. +- Don’t use `cut`. + - Use `bash`'s built-in [parameter expansion](http://wiki.bash-hackers.org/syntax/pe). - Don’t use `echo`. - Use `printf "%s\n"` - Don’t use `bc`.