franz-go icon indicating copy to clipboard operation
franz-go copied to clipboard

Git Tags/Versions Not Quite Right?

Open steve-gray opened this issue 1 year ago • 2 comments

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

steve-gray avatar Jul 30 '22 04:07 steve-gray

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

godwhoa avatar Jul 30 '22 11:07 godwhoa

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

twmb avatar Aug 01 '22 15:08 twmb

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

twmb avatar Aug 05 '22 20:08 twmb

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).

steve-gray avatar Aug 06 '22 00:08 steve-gray

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.

twmb avatar Aug 22 '22 19:08 twmb