Skip to content

Commit 5fccfb3

Browse files
committed
Add a Contributing file with some Bash guidelines
1 parent a847bef commit 5fccfb3

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

.github/Contributing.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Bash Style Conventions
2+
3+
* Use spaces for indentation.
4+
No tabs please.
5+
* Use 4 space indent.
6+
* Keep lines under 80 chars if possible.
7+
* Always use `[[ ... ]]`, not `[ ... ]` form.
8+
* Don't use `-n`.
9+
* Don't quote things that don't need quotes.
10+
* Unless it really adds to readability.
11+
* If script is long, break into functions and use a `main` function at top.
12+
* Function names should be `foo-bar` not `foo_bar`.
13+
* Define functions `foo-bar() ( ... )`, not `function foo-bar ( ... )`.
14+
15+
## Testing
16+
17+
* Run `make test`.

0 commit comments

Comments
 (0)