Skip to content

Commit c0f89fb

Browse files
authored
docs: add explanation about the configuration inside repo (#4466)
1 parent 1b0dbb0 commit c0f89fb

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

.golangci.yml

+16-11
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
# This configuration file is not a recommendation.
2+
#
3+
# We intentionally use a limited set of linters.
4+
# This configuration file is used with different version of golangci-lint to avoid regressions:
5+
# the linters can change between version,
6+
# their configuration may be not compatible or their reports can be different,
7+
# and this can break some of our tests.
8+
# Also, some linters are not relevant for the project (e.g. linters related to SQL).
9+
#
10+
# We have specific constraints, so we use a specific configuration.
11+
#
12+
# See the file `.golangci.reference.yml` to have a list of all available configuration options.
13+
114
linters-settings:
215
depguard:
316
rules:
@@ -118,17 +131,9 @@ linters:
118131
- unused
119132
- whitespace
120133

121-
# don't enable:
122-
# - asciicheck
123-
# - gochecknoglobals
124-
# - gocognit
125-
# - godot
126-
# - godox
127-
# - goerr113
128-
# - nestif
129-
# - prealloc
130-
# - testpackage
131-
# - wsl
134+
# This list of linters is not a recommendation (same thing for all this configuration file).
135+
# We intentionally use a limited set of linters.
136+
# See the comment on top of this file.
132137

133138
issues:
134139
# Excluding configuration per-path, per-linter, per-text and per-source

0 commit comments

Comments
 (0)