From 55f60d849ff7f37dbc6c5cd28ad2357d53ea58c6 Mon Sep 17 00:00:00 2001 From: rwxrob Date: Tue, 10 Aug 2021 19:37:51 -0400 Subject: [PATCH] Improve guidelines --- README.md | 10 +++++++--- command | 8 ++++++-- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9637d29..baf5b2f 100644 --- a/README.md +++ b/README.md @@ -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 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` * 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 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* diff --git a/command b/command index 2a6a5be..7904283 100755 --- a/command +++ b/command @@ -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 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` * 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 use `bc` for *any* floating point math