add documentation for verify-gofmt script

This commit is contained in:
Pravar Agrawal 2021-10-08 23:05:11 +05:30
parent ec0dcfbcc2
commit 9791d9897a
1 changed files with 10 additions and 0 deletions

View File

@ -181,3 +181,13 @@ klog methods which have few disallowed keywords like,
More info is available
[here](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/migration-to-structured-logging.md#change-log-functions-to-structured-equivalent).
## `verify-gofmt`
This script is used to check whether the go source code needs to be
formatted or not using, the gofmt tool. Gofmt tool automatically
formats the code and the formatted code is easier to read, write and
maintain.