chore: repo to work with local go.work file (#1073)

* chore: add go.work files to gitignore Signed-off-by: András Jáky <[email protected]> * docs: extend contributing guide with using go.work Signed-off-by: András Jáky <[email protected]> --------- Signed-off-by: András Jáky <[email protected]>
openclarity · Jan 17, 2024 · 33c775e · 33c775e
1 parent 880e300
commit 33c775e
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,4 @@ bin/
 db.db
 site/
 dist
+go.work*
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -42,6 +42,22 @@ possible, and, if possible, a test case.
 
 ## Development
 
+### Development Environment
+
+For the `gopls` language server to index the whole project, it is possible to create a local `go.work` file including the current go version used and the modules, followed by running `go mod tidy`, such as:
+
+```text
+go 1.21.4
+
+use (
+    ./api
+    ./e2e
+    ./
+)
+
+// maybe replaces if there are conflicts
+```
+
 ### Building VMClarity Binaries
 
 Makefile targets are provided to compile and build the VMClarity binaries.
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,3 +6,4 @@ bin/ @@
     db.db
     site/
     dist
+    go.work*