Skip to content

Commit 8e769c9

Browse files
committed
docs: add explanation about the list of linters inside repo configuration.
1 parent 4fea092 commit 8e769c9

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

.golangci.yml

+8-11
Original file line numberDiff line numberDiff line change
@@ -118,17 +118,14 @@ linters:
118118
- unused
119119
- whitespace
120120

121-
# don't enable:
122-
# - asciicheck
123-
# - gochecknoglobals
124-
# - gocognit
125-
# - godot
126-
# - godox
127-
# - goerr113
128-
# - nestif
129-
# - prealloc
130-
# - testpackage
131-
# - wsl
121+
# This list of linters is not a recommendation (same thing for all this configuration file).
122+
# We intentionally use limited set of linter:
123+
# this configuration file is used with different version of golangci-lint to avoid regressions.
124+
# As the linters can change between version,
125+
# the configuration may be not compatible or the reports can be different,
126+
# and this can break some of our tests.
127+
# Also, some linters are not relevant for the project (ex: linters related to SQL).
128+
# We have specific constraints, so we use a specific configuration.
132129

133130
issues:
134131
# Excluding configuration per-path, per-linter, per-text and per-source

0 commit comments

Comments
 (0)