aboutsummaryrefslogtreecommitdiff
path: root/STYLE-GUIDE.md
diff options
context:
space:
mode:
Diffstat (limited to 'STYLE-GUIDE.md')
-rw-r--r--STYLE-GUIDE.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/STYLE-GUIDE.md b/STYLE-GUIDE.md
new file mode 100644
index 0000000..21f1523
--- /dev/null
+++ b/STYLE-GUIDE.md
@@ -0,0 +1,17 @@
+Style Guide
+-----------
+
+Usage
+=====
+
+* Always echo to `stderr`.
+* Exit with code 1.
+* Enclose required arguments in angle brackets: `-v <version>`
+* Enclose optional arguments in square brackets: `[-h hook]`
+
+ usage() {
+ echo "usage: $0 -v <version> [-h hook]"
+ exit 1
+ }
+
+