docs: Add golangci-lint and pre-commit dev docs #529
Conversation
kubevirt-bot
added
release-note-none
docs/development.md
Outdated
| make lint | ||
| test -s /src/ssp-operator/bin/golangci-lint || curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b /src/ssp-operator/bin v1.51.1 | ||
| /src/ssp-operator/bin/golangci-lint run --timeout 5m |
There was a problem hiding this comment.
This script block looks confusing to me, because input and output are shown in the same code block without any distinction. Can you only keep input?
make lint
docs/development.md
Outdated
| pip install --user pre-commit | ||
| pre-commit install | ||
| git commit -s | ||
| [..] | ||
| trim trailing whitespace.................................................Passed | ||
| fix end of files.........................................................Passed | ||
| check yaml...........................................(no files to check)Skipped | ||
| check for added large files..............................................Passed | ||
| check for merge conflicts................................................Passed | ||
| check that executables have shebangs.................(no files to check)Skipped | ||
| check that scripts with shebangs are executable..........................Passed | ||
| detect private key.......................................................Passed | ||
| mixed line ending........................................................Passed | ||
| lint.....................................................................Passed |
There was a problem hiding this comment.
The same here. Can you keep only input? Or show the output in a different block?
Signed-off-by: Lee Yarwood <lyarwood@redhat.com>
lyarwood
force-pushed
the
golangci-lint-pre-commit-docs
branch
from
836b37f
to
0e52159
Compare
|
Kudos, SonarCloud Quality Gate passed!
|
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: 0xFelix The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
kubevirt-bot
added
the
approved
What this PR does / why we need it:
Adds missing dev docs for
golangci-lintandpre-commit.Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Release note: