Re-add comments to golangci-lint config

These were dropped during the migration to v2. Re-add them.

Signed-off-by: Stephen Finucane <[email protected]>

Author: stephenfin

.golangci.yml

@@ -49,12 +49,13 @@ linters:
     - wastedassign
     - whitespace
   settings:
+    # TODO(sbuerin) fix remaining findings and set to 20 afterwards
     cyclop:
       max-complexity: 30
     gocritic:
       disabled-checks:
         - appendAssign
-        - dupImport
+        - dupImport # https://github.com/go-critic/go-critic/issues/845
         - evalOrder
         - ifElseChain
         - octalLiteral
@@ -74,6 +75,7 @@ linters:
         - performance
     importas:
       alias:
+        # Kubernetes
         - pkg: k8s.io/api/core/v1
           alias: corev1
         - pkg: k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1
@@ -84,14 +86,17 @@ linters:
           alias: apierrors
         - pkg: k8s.io/apimachinery/pkg/util/errors
           alias: kerrors
+        # Controller Runtime
         - pkg: sigs.k8s.io/controller-runtime
           alias: ctrl
+        # CAPO
         - pkg: sigs.k8s.io/cluster-api-provider-openstack/api/v1alpha1
           alias: infrav1alpha1
         - pkg: sigs.k8s.io/cluster-api-provider-openstack/api/v1beta1
           alias: infrav1
         - pkg: sigs.k8s.io/cluster-api-provider-openstack/pkg/utils/errors
           alias: capoerrors
+        # CAPI
         - pkg: sigs.k8s.io/cluster-api/api/v1alpha3
           alias: clusterv1alpha3
         - pkg: sigs.k8s.io/cluster-api/api/v1alpha4
@@ -110,24 +115,31 @@ linters:
           alias: v1beta1patch
         - pkg: sigs.k8s.io/cluster-api/api/ipam/v1beta2
           alias: ipamv1
+        # CABPK
         - pkg: sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1alpha3
           alias: bootstrapv1alpha3
         - pkg: sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1alpha4
           alias: bootstrapv1alpha4
         - pkg: sigs.k8s.io/cluster-api/bootstrap/kubeadm/api/v1beta1
           alias: bootstrapv1
+        # KCP
         - pkg: sigs.k8s.io/cluster-api/controlplane/kubeadm/api/v1alpha3
           alias: controlplanev1alpha3
         - pkg: sigs.k8s.io/cluster-api/controlplane/kubeadm/api/v1alpha4
           alias: controlplanev1alpha4
         - pkg: sigs.k8s.io/cluster-api/controlplane/kubeadm/api/v1beta1
           alias: controlplanev1
+        # ORC
         - pkg: github.com/k-orc/openstack-resource-controller/api/v1alpha1
           alias: orcv1alpha1
       no-unaliased: true
     nestif:
+      # minimal complexity of if statements to report, 5 by default
+      # TODO(sbuerin) fix remaining findings and set to 5 after:
+      # https://github.com/kubernetes-sigs/cluster-api-provider-openstack/pull/778
       min-complexity: 13
     nolintlint:
+      # https://github.com/golangci/golangci-lint/issues/3228
       allow-unused: true
   exclusions:
     generated: lax
@@ -136,13 +148,15 @@ linters:
       - common-false-positives
       - legacy
       - std-error-handling
+    # List of regexps of issue texts to exclude, empty list by default.
     rules:
       - linters:
           - gosec
         text: 'G108: Profiling endpoint is automatically exposed on /debug/pprof'
       - linters:
           - gosec
         text: 'G108: Profiling endpoint is automatically exposed on /debug/pprof'
+      # This directive allows the embed package to be imported with an underscore everywhere.
       - linters:
           - revive
         source: _ "embed"