jmmv / sourcachefs Goto Github PK

Thanks for publishing this!

Currently, your import paths don’t resolve: you use e.g. github.com/jmmv/sourcachefs/fs in code, but go get will not be able to download that package, because it lives in src/github.com/jmmv/sourcachefs/fs instead of fs.

This decision affects many downstream tools, such as godoc.org (for automatic API documentation) or packaging helpers (making it hard to package sourcachefs for Debian and others).

Please consider structuring your repository like so:

1. Place the source directly in your repository, i.e. mv src/github.com/jmmv/sourcachefs/* .
2. Place packages which are not supposed to be used by others in an internal subdirectory. See https://docs.google.com/document/d/1e8kOo3r51b2BWtTs_1uADIA5djfXhPT36s6eHVRIvaU/edit
3. (Place executable commands in a cmd subdirectory, e.g. cmd/sourcachefs.)
4. If you need specific versions or custom patches to dependencies, vendor them using the https://github.com/golang/dep tool.

For an example of this structure, see e.g. https://github.com/Debian/debiman/

The end result should be that users will be able to install/update your software using go get -u github.com/jmmv/sourcachefs/cmd/sourcachefs.

Thanks for considering.