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

Git Tags/Versions Not Quite Right? #183

Closed
steve-gray opened this issue Jul 30, 2022 · 5 comments
Closed

Git Tags/Versions Not Quite Right? #183

steve-gray opened this issue Jul 30, 2022 · 5 comments

Comments

@steve-gray
Copy link

steve-gray commented Jul 30, 2022

Edit: Ignore, can delete. Turns out we'd were go getting the root package which is't a go package root.

@godwhoa
Copy link

godwhoa commented Jul 30, 2022

Would an import statement in the getting started example help prevent this confusion?

@twmb
Copy link
Owner

twmb commented Aug 1, 2022

I think an "install" block might be useful, since there are many modules in this one repo which is pretty uncommon.

@twmb twmb closed this as completed in afa8f65 Aug 5, 2022
@twmb
Copy link
Owner

twmb commented Aug 5, 2022

lmk if the recently pushed install block clears things up or not :)

@steve-gray
Copy link
Author

steve-gray commented Aug 6, 2022

I suspect it'd be far more informative/better to add the import directives to the examples showing that the package is not rooted at the base of the repo - which is essentially the de-facto standard for most mainstream packages. Obviously this can't be readily changed retrospectively, so the import as @godwhoa said above would illustrate the point.

Otherwise people will be trying to figure out where kgo comes from (and as in my case, referencing the root and wondering why go get fails silently).

@twmb twmb reopened this Aug 13, 2022
@twmb twmb closed this as completed in 894c839 Aug 22, 2022
@twmb
Copy link
Owner

twmb commented Aug 22, 2022

I've expanded the wording a little bit. However, given the many examples, and the readme, and how other projects do it, I'm not sure how much more it makes sense to continue adding to the readme.

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

No branches or pull requests

3 participants