aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorSerene Han <keroserene+git@gmail.com>2016-01-27 11:22:24 -0800
committerSerene Han <keroserene+git@gmail.com>2016-01-27 11:22:24 -0800
commit335925dcc8df3a1ab1bf365ccd0bd4e886aaec82 (patch)
tree3ddec050aab797545587bc898c372148d6a838af /CONTRIBUTING.md
parente1f6c7fc5d5be29d66e79a9970cdfba4e26d6baa (diff)
downloadsnowflake-335925dcc8df3a1ab1bf365ccd0bd4e886aaec82.tar.gz
snowflake-335925dcc8df3a1ab1bf365ccd0bd4e886aaec82.zip
add CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..1bb064f
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,9 @@
+
+- When editing Go, please run `go fmt` before every commit.
+
+- When editing coffeescript (in the `proxy/` directory), please run
+ `cake lint` and resolve any lint issues before every commit.
+
+- You may run tests locally with either `go test` or `cake test` for Go and
+ coffeescript, respectively.
+