From dbc31fdc9bc0493ebf2dfd98859e2e989385d389 Mon Sep 17 00:00:00 2001 From: Fernandez Ludovic Date: Thu, 7 Mar 2024 17:12:59 +0100 Subject: [PATCH 1/3] docs: add explanation about the list of linters inside repo configuration. --- .golangci.yml | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/.golangci.yml b/.golangci.yml index 322ed8dc0082..5659525a3868 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -118,17 +118,14 @@ linters: - unused - whitespace - # don't enable: - # - asciicheck - # - gochecknoglobals - # - gocognit - # - godot - # - godox - # - goerr113 - # - nestif - # - prealloc - # - testpackage - # - wsl + # This list of linters is not a recommendation (same thing for all this configuration file). + # We intentionally use a limited set of linters. + # This configuration file is used with different version of golangci-lint to avoid regressions: + # the linters can change between version, + # their configuration may be not compatible or their reports can be different, + # and this can break some of our tests. + # Also, some linters are not relevant for the project (ex: linters related to SQL). + # We have specific constraints, so we use a specific configuration. issues: # Excluding configuration per-path, per-linter, per-text and per-source From 8e5ef2d0d0e383e4cbd4898de092848df09fd706 Mon Sep 17 00:00:00 2001 From: Ludovic Fernandez Date: Thu, 7 Mar 2024 17:35:26 +0100 Subject: [PATCH 2/3] review Co-authored-by: Oleksandr Redko --- .golangci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.golangci.yml b/.golangci.yml index 5659525a3868..e58d35a2b9a1 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -124,7 +124,7 @@ linters: # the linters can change between version, # their configuration may be not compatible or their reports can be different, # and this can break some of our tests. - # Also, some linters are not relevant for the project (ex: linters related to SQL). + # Also, some linters are not relevant for the project (e.g., linters related to SQL). # We have specific constraints, so we use a specific configuration. issues: From 5315fee76d37ab1317e7b56c825341ec69fdc020 Mon Sep 17 00:00:00 2001 From: Fernandez Ludovic Date: Thu, 7 Mar 2024 19:20:42 +0100 Subject: [PATCH 3/3] docs: add top comment --- .golangci.yml | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/.golangci.yml b/.golangci.yml index e58d35a2b9a1..48c3d05e13a2 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -1,3 +1,16 @@ +# This configuration file is not a recommendation. +# +# We intentionally use a limited set of linters. +# This configuration file is used with different version of golangci-lint to avoid regressions: +# the linters can change between version, +# their configuration may be not compatible or their reports can be different, +# and this can break some of our tests. +# Also, some linters are not relevant for the project (e.g. linters related to SQL). +# +# We have specific constraints, so we use a specific configuration. +# +# See the file `.golangci.reference.yml` to have a list of all available configuration options. + linters-settings: depguard: rules: @@ -120,12 +133,7 @@ linters: # This list of linters is not a recommendation (same thing for all this configuration file). # We intentionally use a limited set of linters. - # This configuration file is used with different version of golangci-lint to avoid regressions: - # the linters can change between version, - # their configuration may be not compatible or their reports can be different, - # and this can break some of our tests. - # Also, some linters are not relevant for the project (e.g., linters related to SQL). - # We have specific constraints, so we use a specific configuration. + # See the comment on top of this file. issues: # Excluding configuration per-path, per-linter, per-text and per-source