test: add more linting configuration & documentation

Author: morremeyer

.github/semantic.yml

@@ -0,0 +1,2 @@
+commitsOnly: true
+allowMergeCommits: false

.github/workflows/pre-commit.yml

@@ -11,4 +11,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/[email protected]
+
+      - uses: actions/setup-go@v2
+        with:
+          # renovate: go-version
+          go-version: 1.17.7
+
+      - name: Install go tooling
+        run: |
+          go get golang.org/x/lint/golint
+          go get golang.org/x/tools/cmd/goimports
+          go get github.com/fzipp/gocyclo/cmd/gocyclo
+
       - uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -7,6 +7,17 @@ repos:
         stages: [commit-msg]
         additional_dependencies: ["@commitlint/config-conventional"]
 
+  - repo: https://github.com/dnephin/pre-commit-golang
+    rev: v0.5.0
+    hooks:
+      - id: go-fmt
+      - id: go-vet
+      - id: go-mod-tidy
+      - id: go-lint # requires golang.org/x/lint/golint
+      - id: go-imports # requires golang.org/x/tools/cmd/goimports
+      - id: go-cyclo # requires github.com/fzipp/gocyclo/cmd/gocyclo
+        args: [-over=15]
+
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v2.5.1
     hooks:

CONTRIBUTING.md

@@ -2,10 +2,28 @@
 
 Contributions are welcome. Please note the [Code of Conduct](CODE_OF_CONDUCT.md) and set up pre-commit as described below.
 
-## Repository setup
+## Tool & Repository setup
 
-Please set up pre-commit after cloning the repository:
+CI pipelines check all code changes when you open a PR. To not have to go back and fix all issues manually, the following setup is recommended.
+
+You will need the following tools:
+
+- [go](https://go.dev/). For the specific version used, check the [pre-commit workflow](.github/workflows/pre-commit.yml) at the `go-version` configuration
+- [pre-commit](https://pre-commit.com/)
+
+Once this is done, run the following:
 
 ```sh
+# Linters used with pre-commit
+go install golang.org/x/lint/golint@latest
+go install golang.org/x/tools/cmd/goimports@latest
+go install github.com/fzipp/gocyclo/cmd/gocyclo@latest
+
+# Set up pre-commit hooks
 pre-commit install --hook-type commit-msg --hook-type pre-commit
 ```
+
+## Commit messages
+
+This project uses [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/)
+to enable better overview over changes and enables automated tooling based on commit messages.

go.mod

@@ -0,0 +1,3 @@
+module github.com/envelope-zero/backend
+
+go 1.17

go.sum

@@ -7,5 +7,16 @@
   "labels": ["renovate"],
   "rangeStrategy": "pin",
   "rebaseWhen": "behind-base-branch",
-  "semanticCommits": "enabled"
+  "semanticCommits": "enabled",
+  "regexManagers": [
+    {
+      "description": "Upgrade go version in a GitHub workflow",
+      "fileMatch": ["(^workflow-templates|\\.github/workflows)/[^/]+\\.ya?ml$"],
+      "matchStrings": [
+        "# renovate: go-version\\s*go-version:\\s*\"?(?<currentValue>.*)\"?"
+      ],
+      "datasourceTemplate": "golang-version",
+      "depNameTemplate": "go"
+    }
+  ]
 }