docs: update contributing guide (#2586)

* chore: update make targets

* docd: update contributing guides with go.mod and lint work

* docs: wording

.github/workflows/ci-test-go.yml

@@ -91,7 +91,7 @@ jobs:
 
       - name: modTidy
         working-directory: ./${{ inputs.project-directory }}
-        run: make tools-tidy
+        run: make tidy
 
       - name: ensure compilation
         working-directory: ./${{ inputs.project-directory }}

Makefile

@@ -6,12 +6,13 @@ test-all: tools test-tools test-unit
 .PHONY: test-examples
 test-examples:
 	@echo "Running example tests..."
-	make -C examples test
+	$(MAKE) -C examples test
 
 .PHONY: tidy-all
 tidy-all:
-	make -C examples tidy-examples
-	make -C modules tidy-modules
+	$(MAKE) tidy
+	$(MAKE) -C examples tidy-examples
+	$(MAKE) -C modules tidy-modules
 
 ## -------------------------------------
 

commons-test.mk

@@ -47,6 +47,6 @@ tools:
 .PHONY: test-tools
 test-tools: $(GOBIN)/gotestsum
 
-.PHONY: tools-tidy
-tools-tidy:
+.PHONY: tidy
+tidy:
 	go mod tidy

docs/contributing.md

@@ -8,5 +8,9 @@
     * follow the style, naming and structure conventions of the rest of the project.
     * make commits atomic and easy to merge.
     * when updating documentation, please see [our guidance for documentation contributions](contributing_docs.md).
-    * apply format running `go fmt`, or the shell script `./scripts/checks.sh`
+    * when updating the `go.mod` file, please run `make tidy-all` to ensure all modules are updated. It will run `golangci-lint` with the configuration set in the root directory of the project. Please be aware that the lint stage could fail if this is not done.
+    * apply format running `make lint`
+        * For examples: `make -C examples lint`
+        * For modules: `make -C modules lint`
     * verify all tests are passing. Build and test the project with `make test-all` to do this.
+        * For a given module or example, go to the module or example directory and run `make test`.

examples/Makefile

@@ -10,4 +10,4 @@ lint-examples:
 
 .PHONY: tidy-examples
 tidy-examples:
-	@find . -type f -name Makefile -execdir make tools-tidy \;
+	@find . -type f -name Makefile -execdir make tidy \;

modules/Makefile

@@ -10,4 +10,4 @@ lint-modules:
 
 .PHONY: tidy-modules
 tidy-modules:
-	@find . -type f -name Makefile -execdir make tools-tidy \;
+	@find . -type f -name Makefile -execdir make tidy \;