Some hints about go development

cloud-gov · Apr 13, 2017 · a81de2d · a81de2d
1 parent bb08f04
commit a81de2d
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -53,6 +53,18 @@ Then edit the file `~/.env/cg-dashboard` and provide the proper values. When you
 - `CONSOLE_LOG_URL`: The URL of the loggregator service. i.e. `http://loggregator.domain.com`
 - `PPROF_ENABLED`: <optional> If set to `true` or `1`, will turn on `/debug/pprof` endpoints as seen [here](https://golang.org/pkg/net/http/pprof/)
 
+
+#### Codecheck
+
+To run the go tests:
+
+    $ ./codecheck.sh
+
+`fmt` can be used to fix any linting errors:
+
+    $ go fmt ./controllers
+
+
 ### Front end
 Front end build commands should be run in the same directory as the `package.json` file. If you've used the cloning command from this README it should be something like `/path/to/cg-dashboard-ws/src/github.com/18F/cg-dashboard`. Node version 6 and above should always be used.