From 9b90449cb7a980ec14c6378865b826c94056bc5c Mon Sep 17 00:00:00 2001 From: Ben Boyter Date: Tue, 22 Oct 2019 08:31:51 +1100 Subject: [PATCH] Update with hacking section --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 0153a295..922a4bcf 100644 --- a/README.md +++ b/README.md @@ -331,6 +331,12 @@ Estimated People Required 0.250551 ------------------------------------------------------------------------------- ``` +### Development + +If you want to hack away feel free! PR's are accepted. Some things to keep in mind. If you want to change a language definition you need to update `languages.json` and then run `go generate` which will convert it into the `processor/constants.go` file. + +For all other changes ensure you run all tests before submitting. You can do so using `go test ./...`. However for maximum coverage please run `test-all.sh` which will run `gofmt`, unit tests, race detector and then all of the integration tests. All of those must pass to ensure a stable release. + ### API Support The core part of `scc` which is the counting engine is exposed publicly to be integrated into other Go applications. See https://github.com/pinpt/ripsrc for an example of how to do this. However as a quick start consider the following,