interesting
/
template-bash-command
mirror of https://github.com/rwxrob/template-bash-command.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Improve guidelines

This commit is contained in:
rwxrob 2021-08-10 19:37:51 -04:00
parent cede08c518
commit 55f60d849f
No known key found for this signature in database
GPG Key ID: 1CCACEDD2F65578E
2 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -44,11 +44,15 @@ multiple ways of feeding data to loops easily covers the needs
previously requiring Python and Perl scripts. Bash scripts are also much previously requiring Python and Perl scripts. Bash scripts are also much
more powerful, safer, flexible, and performant than POSIX shell or Zsh. more powerful, safer, flexible, and performant than POSIX shell or Zsh.
## Caveats ## Guidelines
* Write GitHub Flavored Markdown only
* Use present tense ("outputs" over "will output")
* Prefer "output" and "display" over ~~print~~
* Follow the [naming conventions](#naming-conventions)
* Use the official bash path: `#!/usr/bin/bash` * Use the official bash path: `#!/usr/bin/bash`
* Using `#!/usr/bin/env bash` introduces unnecessary risk * Using `#!/usr/bin/env bash` introduces unnecessary risk
* Always set the acceptable `PATH` at beginning of script * Explicitly export `PATH` in script when possible
* Always check script with [`shellcheck`] before releasing * Always check script with [`shellcheck`] before releasing
* Always use `bc` for *any* floating point math * Always use `bc` for *any* floating point math
@ -102,5 +106,5 @@ Displays a summary of usage.
---- ----
*Autogenerated Tue Aug 10 07:18:16 PM EDT 2021* *Autogenerated Tue Aug 10 07:37:40 PM EDT 2021*

8
command
View File

@ -60,11 +60,15 @@ multiple ways of feeding data to loops easily covers the needs
previously requiring Python and Perl scripts. Bash scripts are also much previously requiring Python and Perl scripts. Bash scripts are also much
more powerful, safer, flexible, and performant than POSIX shell or Zsh. more powerful, safer, flexible, and performant than POSIX shell or Zsh.
## Caveats ## Guidelines
* Write GitHub Flavored Markdown only
* Use present tense ("outputs" over "will output")
* Prefer "output" and "display" over ~~print~~
* Follow the [naming conventions](#naming-conventions)
* Use the official bash path: `#!/usr/bin/bash` * Use the official bash path: `#!/usr/bin/bash`
* Using `#!/usr/bin/env bash` introduces unnecessary risk * Using `#!/usr/bin/env bash` introduces unnecessary risk
* Always set the acceptable `PATH` at beginning of script * Explicitly export `PATH` in script when possible
* Always check script with [`shellcheck`] before releasing * Always check script with [`shellcheck`] before releasing
* Always use `bc` for *any* floating point math * Always use `bc` for *any* floating point math