mirror of
https://github.com/k3s-io/kubernetes.git
synced 2026-02-22 07:03:28 +00:00
5bfc9aba9f
The golangci-lint docs indicate that, for gocritic, disabled-checks and enabled-checks can't be combined. That is however not accurate; enabled-checks adds checks, disabled-checks disables them, in that order. If disable-all isn't set, then the setup starts with the checks enabled by default, adds any additional checks specified in enabled-checks, and removes checks specified in disabled-checks. This means that instead of filtering unwanted checks, we can disable them entirely. This makes the set of disabled checks easier to read, and perhaps easier to clean up in future. For singleCaseSwitch and wrapperFunc, we only want to ignore specific instances, so this is still done by filtering. Signed-off-by: Stephen Kitt <skitt@redhat.com>
Kubernetes hack GuideLines
This document describes how you can use the scripts from hack directory
and gives a brief introduction and explanation of these scripts.
Overview
The hack directory contains many scripts that ensure continuous development of kubernetes,
enhance the robustness of the code, improve development efficiency, etc.
The explanations and descriptions of these scripts are helpful for contributors.
For details, refer to the following guidelines.
Key scripts
verify-all.sh: This script is a vestigial redirection, Please do not add "real" logic. It is equivalent tomake verify.update-all.sh: This script is a vestigial redirection, Please do not add "real" logic. Thetruetarget of this makerule ishack/make-rules/update.sh.It is equivalent tomake update.
Attention
Note that all scripts must be run from the Kubernetes root directory.
We should run hack/verify-all.sh before submitting a PR and if anything fails run hack/update-all.sh.