chore(docs): add fmt check and update CONTRIBUTING.md

.github/workflows/on_push.yml

@@ -87,3 +87,17 @@ jobs:
 
       - name: Check vendor
         run: make vendor-check
+
+  lint:
+    name: Lint & Format
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Go 1.20
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.20.x
+
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - run: make check-fmt

.gitignore

@@ -12,3 +12,4 @@ private-key.key
 /vendor
 /pkg/.patched-proto
 y.output
+report.xml

CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing
+
+Deep uses GitHub to manage reviews of pull requests:
+
+- If you have a trivial fix or improvement, go ahead and create a pull request.
+- If you plan to do something more involved, discuss you ideas on the relevant GitHub issue.
+
+# Dependency Management
+
+We use Go modules to manage dependencies on external packages. This requires a working Go environment with version 1.18
+or greater and git installed.
+
+To add or update a new dependency, use the `go get` command:
+
+```bash
+# Pick the latest tagged release.
+go get example.com/some/module/pkg
+
+# Pick a specific version
+go get example.com/some/module/pkg@vX.Y.Z
+```
+
+Before submitting please run the following to verify that all dependencies and proto definitions are consistent.
+
+```bash
+make vendor-check
+```
+
+Additionally, this project uses [`gofumpt`](https://github.com/mvdan/gofumpt) to format the style of the go code. Ensure that `make fmt` has been run before
+submitting.

Makefile

@@ -95,7 +95,7 @@ exe-debug:
 .PHONY: fmt check-fmt
 fmt:
 	echo $(FILES_TO_FMT)
-	@gofmt -s -w $(FILES_TO_FMT)
+	@gofumpt -l -w .
 	@goimports -w $(FILES_TO_FMT)
 
 check-fmt: fmt

README.md

@@ -74,11 +74,12 @@ Here is a quick summary of the features and supported options:
    - :heavy_check_mark: AWS: Tested with EKS and S3
    - :warning: GCS: Support is available, but it is not tested
    - :warning: Azure: Support is available, but it is not tested
- - :x: Distributed Mode: This is not available yet - only single binary support is currently working
- - :warning: Multi Tenancy: Support is available, but it has not been tested
+ - :heavy_check_mark: Distributed Mode: This is available and working
+ - :heavy_check_mark: Multi Tenancy: This is available and working
+ - :heavy_check_mark: Helm: [helm chart](https://github.com/intergral/deep-helm) deployments are available
  - :x: DeepQL: Initial steps are complete, but it is not available yet.
  - Language Support:
-   - :heavy_check_mark: [Java](https://github.com/intergral/deep-java-client) - The agent is available and released as version 1.0.0
+   - :heavy_check_mark: [Java](https://github.com/intergral/deep-java-client) - The agent is available and released as version 1.1.0
    - :heavy_check_mark: [Python](https://github.com/intergral/deep-python-client) - The Agent is available and released as version 1.0.0
    - Other languages (Ruby, Go, Node, .Net) are planned but not started.
 

docs/docs/index.md

@@ -15,6 +15,10 @@ To use deep you need to deploy the service, there are a few options for this:
 
 Once the service is deployed you will need to setup a client and connect Grafana to the service.
 
+## Helm
+To use deep with Helm see our dedicated project and site:
+[github](intergral/deep-helm)
+
 ### Grafana
 
 To connect grafana to DEEP you will need to install the deep plugins.
@@ -31,4 +35,3 @@ available clients are:
 
 - [github](intergral/deep-python-client)
 - [github](intergral/deep-java-client)
-- [github](intergral/deep-java-client)