github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-09 12:07:47 +00:00
Code Issues Projects Releases Wiki Activity

verify-golangci-lint.sh: clarify intended usage of warnings

Browse Source 
Contributors have created PRs because the linter found them. That is often not
necessary and should be discussed before working on a PR.

While at it, output formatting gets updated a bit (extra blank lines, wording).
This commit is contained in:
Patrick Ohly 2023-10-24 14:39:17 +02:00
parent 2f270bd996
commit ae5bf8e4c6
1 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
hack/verify-golangci-lint.sh
View File

@ -199,18 +199,30 @@ else
echo 'If the above warnings do not make sense, you can exempt this warning with a comment'
echo ' (if your reviewer is okay with it).'
if [ "$strict" ]; then
echo 'The more strict golangci-strict.yaml was used.'
echo
echo 'golangci-strict.yaml was used as configuration. Warnings must be fixed in'
echo 'new or modified code.'
elif [ "$hints" ]; then
echo 'The golangci-hints.yaml was used. Some of the reported issues may have to be fixed'
echo 'while others can be ignored, depending on the circumstances and/or personal'
echo 'preferences. To determine which issues have to be fixed, check the report that'
echo 'uses golangci-strict.yaml.'
echo
echo 'golangci-hints.yaml was used as configuration. Some of the reported issues may'
echo 'have to be fixed while others can be ignored, depending on the circumstances'
echo 'and/or personal preferences. To determine which issues have to be fixed, check'
echo 'the report that uses golangci-strict.yaml (= pull-kubernetes-verify-lint).'
fi
if [ "$strict" ] || [ "$hints" ]; then
echo
echo 'If you feel that this warns about issues that should be ignored by default,'
echo 'then please discuss with your reviewer and propose'
echo 'a change for hack/golangci.yaml.in as part of your PR.'
echo
echo 'Please do not create PRs which fix these issues in existing code just'
echo 'because the linter warns about them. Often they are harmless and not'
echo 'worth the cost associated with a PR (time required to review, code churn).'
echo 'Instead, propose to fix certain linter issues in an issue first and'
echo 'discuss there with maintainers. PRs are welcome if they address a real'
echo 'problem, which then needs to be explained in the PR.'
fi
echo
echo 'In general please prefer to fix the error, we have already disabled specific lints'
echo ' that the project chooses to ignore.'
echo 'See: https://golangci-lint.run/usage/false-positives/'