Skip to content

Commit 22d62ce

Browse files
committed
README: Add info about linting
1 parent 19312b3 commit 22d62ce

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,31 @@ ksau
44

55
## Overview
66
A simple tool written in bash to use my index for uploading files.
7-
Might be alternative to `bash-upload`, `we-transfer`, `transfer.sh`.
7+
Might be alternative to `bash-upload`, `we-transfer`, `transfer.sh`.
8+
9+
## Contributing
10+
If you want to contribute, please make sure you have `shfmt` installed, and run
11+
`make lint` before commiting. This ensures tabs and spaces does not get mixed,
12+
as well as consistent styling.
13+
14+
```bash
15+
# For example, shfmt will ensure:
16+
if condition
17+
then
18+
do_stuff
19+
else
20+
do_stuff
21+
fi
22+
23+
# is always written as:
24+
if condition; then
25+
do_stuff
26+
else
27+
do_stuff
28+
fi
29+
30+
# The same applies to loops and switch statements (case;esac)
31+
```
832

933
## How to get started
1034
### For Linux/macOS/BSD systems.

0 commit comments

Comments
 (0)