beenull/neofetch
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: update

Browse source
This commit is contained in:
Dylan Araps 2018-05-04 17:51:53 +10:00
parent 5bad6ea5d9
commit 22a43204fc
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTING.md
View file

@ -15,6 +15,9 @@
## Coding Conventions ## Coding Conventions
- Use `bash` built-ins wherever possible.
- Try not to pipe (`|`) at all.
- Limit usage of external commands `$(cmd)`.
- Indent 4 spaces. - Indent 4 spaces.
- Use [snake_case](https://en.wikipedia.org/wiki/Snake_case) for function - Use [snake_case](https://en.wikipedia.org/wiki/Snake_case) for function
and variable names. and variable names.
@ -42,6 +45,10 @@ request on the repo and our Travis.ci hook will run ShellCheck for you.
### No no's ### 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`. - Don’t use `echo`.
- Use `printf "%s\n"` - Use `printf "%s\n"`
- Don’t use `bc`. - Don’t use `bc`.