Skip to content

Commit

Permalink
Update with hacking section
Browse files Browse the repository at this point in the history
  • Loading branch information
boyter committed Oct 21, 2019
1 parent 282db0a commit 9b90449
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 9b90449

Please sign in to comment.