docs: update CONTRIBUTING.md to reflect current tooling and practices - #14098
Conversation
Signed-off-by: Guillaume Lours <glours@users.noreply.github.com>
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🟡 NEEDS ATTENTION
One medium-severity documentation inaccuracy was found in the new content introduced by this PR.
| and maintenance. Always run `gofmt -s -w file.go` on each changed file before | ||
| committing your changes. Most editors have plug-ins that do this automatically. | ||
| and maintenance. Formatting is enforced by `golangci-lint` (using `gofumpt`); | ||
| run `golangci-lint run ./...` or `make lint` before committing. Most editors |
There was a problem hiding this comment.
[medium] golangci-lint run ./... is missing the required --build-tags "e2e" flag
The command introduced here omits --build-tags "e2e", which the project's AGENTS.md requires:
Run:
golangci-lint run --build-tags "e2e" ./...
Without this flag, golangci-lint silently skips all e2e-specific code (pkg/e2e/), so contributors following these instructions will get incomplete lint results and may miss failures that CI would catch.
The same line already offers make lint as an alternative (which presumably encodes the correct flags), so the simplest fix is to either:
- Update the direct command:
golangci-lint run --build-tags "e2e" ./... - Remove the direct command and only suggest
make lint
| run `golangci-lint run ./...` or `make lint` before committing. Most editors | |
| run `golangci-lint run --build-tags "e2e" ./...` or `make lint` before committing. Most editors |
| Confidence | Score |
|---|---|
| 🟡 moderate | 60/100 |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
3 participants
What I did
updated
CONTRIBUTING.mdto reflect current tooling and practicesRelated issue
(not mandatory) A picture of a cute animal, if possible in relation to what you did