Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing information on requirements for local setup #7

Open
bocytko opened this issue Jan 9, 2025 · 0 comments
Open

Missing information on requirements for local setup #7

bocytko opened this issue Jan 9, 2025 · 0 comments

Comments

@bocytko
Copy link
Member

bocytko commented Jan 9, 2025

Since running the linter will be required for contributions, we should be explicit about the requirements for the development environment:

$ make lint
golint -set_exit_status
make: golint: No such file or directory
make: *** [lint] Error 1

lint:
golint -set_exit_status $(SOURCE_DIRS)
golangci-lint run
uses at least golint and golangci-lint.

For godoc the behavior is different:

$ make godoc
go install github.com/princjef/gomarkdoc/cmd/gomarkdoc@latest
go: downloading github.com/princjef/gomarkdoc v1.1.0
go: downloading github.com/princjef/termdiff v0.1.0
[...]
go: downloading gopkg.in/warnings.v0 v0.1.2
gomarkdoc --output ./docs/receiver.md ./
make: gomarkdoc: No such file or directory
make: *** [godoc] Error 1

Despite the install step, the command was still not available. (I can build and run skipper, but have no explicit env variables set for go).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant