summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorWill Hawkins <[email protected]>2022-03-18 21:20:30 -0400
committerWill Hawkins <[email protected]>2022-03-18 21:20:30 -0400
commit6e5711a1136ae5ed2e0533f1a5d39bb71fb668b5 (patch)
tree87c09b643d13bfbe9c68d3336a87cd04d6856ab6 /README.md
parent8047ec2a26a1c3120b8104318e3c573ac7df9938 (diff)
Make sure that we format with short lines.
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index fafb1cc..5c3b0b0 100644
--- a/README.md
+++ b/README.md
@@ -86,6 +86,20 @@ You can also test against the Apple infrastructure using:
$ ./networkQuality --config mensura.cdn-apple.com --port 443 --path /api/v1/gm/config
```
+## Contributing
+
+We *love* contributions. Before submitting a patch, format your code with `go fmt` *and* `golines`:
+
+```
+$ golines -w -m 80 --shorten-comments .
+```
+
+You can easily install `golines` in to your `${GOPATH}` with
+
+```
+$ go install github.com/segmentio/golines@latest
+```
+
## References
[RFC2026] https://datatracker.ietf.org/doc/html/rfc2026