Skip to content

N
neofetch
Commit 320ad76b authored by Dylan Araps's avatar Dylan Araps
Browse files
Options

docs: update

parent f51de7f1
Show whitespace changes
Inline Side-by-side
Showing with 4 additions and 7 deletions
CONTRIBUTING.md
View file @ 320ad76b
...@@ -23,20 +23,15 @@ ...@@ -23,20 +23,15 @@
and variable names. and variable names.
- Keep lines below `100` characters long. - Keep lines below `100` characters long.
- Use `[[ ]]` for tests. - Use `[[ ]]` for tests.
- Double Quote **EVERYTHING**. - Quote **EVERYTHING**.
- Don’t use single quotes, except for special cases.
### ShellCheck ### ShellCheck
For your contribution to be accepted, your changes need to pass For your contribution to be accepted, your changes need to pass
ShellCheck. ShellCheck.
Run ShellCheck with the following command:
```sh ```sh
# Why do we exclude numerous tests? shellcheck neofetch
# See: https://github.com/dylanaraps/neofetch/wiki/Shellcheck-Exclusions
shellcheck neofetch -e SC1090,SC2009,SC2012,SC2016,SC2034,SC2128,SC2153,SC2154,SC2178,SC2010,SC1004,SC1091,SC1117
``` ```
**Note**: If you have trouble installing ShellCheck. You can open a pull **Note**: If you have trouble installing ShellCheck. You can open a pull
...@@ -58,6 +53,8 @@ request on the repo and our Travis.ci hook will run ShellCheck for you. ...@@ -58,6 +53,8 @@ request on the repo and our Travis.ci hook will run ShellCheck for you.
- Use `bash`'s built-in syntax (`file="$(< /path/to/file.txt)")`). - Use `bash`'s built-in syntax (`file="$(< /path/to/file.txt)")`).
- Don’t use `grep "pattern" | awk '{ printf }'`. - Don’t use `grep "pattern" | awk '{ printf }'`.
- Use `awk '/pattern/ { printf }'` - Use `awk '/pattern/ { printf }'`
- Don’t use `wc`.
- Use `${#var}` or `${#arr[@]}`.
### If Statements ### If Statements
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment