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

README is outdated #1213

Open
kosciCZ opened this issue Nov 5, 2024 · 1 comment
Open

README is outdated #1213

kosciCZ opened this issue Nov 5, 2024 · 1 comment

Comments

@kosciCZ
Copy link

kosciCZ commented Nov 5, 2024

Hey!

I recently attempted contribution (#1212), and had a bit of a tough time getting up and running, because the README is partially outdated. Couple examples:

  • the make install-tools target no longer exists in the Makefile
  • the make docs-preview target no longer exists in the Makefile
  • this might be my inexperience in the golang ecosystem, but it took me a while to figure out I should use asdf to get the right go version installed based on .tool-versions file. Not sure if it is worth mentioning in the README, or if this is just a standard that I'm unfamiliar with.

I'd open up another PR that fixes this, but I'm not really sure on what the correct solution is, so I'm opening an issue instead.

@zregvart
Copy link
Member

zregvart commented Nov 6, 2024

I think the references to targets not present in the Makefile should be removed. We don't mandate the use of asdf, though some of us use it and we do make sure it is up to date with the version in the go.mod. In general using any recent version of golang should be okay, as it will download the appropriate version as needed.

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

2 participants