Refactor file organization #43
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Stebalien
approved these changes
Nov 9, 2019
| @@ -39,7 +39,7 @@ If your existing library (i.e. `go-ipfs` or `go-filecoin`) uses these other olde | |||
|
|
|||
| ```golang | |||
| import ( | |||
| graphsync "github.com/ipfs/go-graphsync" | |||
| graphsync "github.com/ipfs/go-graphsync/impl" | |||
There was a problem hiding this comment.
uber-nit: the go community often uses pkg or even internal (inaccessible to other projects) for packages like this.
There was a problem hiding this comment.
I believe pkg is the dir used for the external packages. Be careful with internal since it's actually enforced (you'll need to put ctors etc outside). See https://github.com/golang-standards/project-layout
LGTM regardless.
anorth
approved these changes
Nov 10, 2019
To reduce future import cycles, and expose more types properly, move the root package to an interface/types file and move the main implementation into /impl. This also exposes an interface other implementers can replace.
hannahhoward
force-pushed
the
feat/organization-refactor
branch
from
708da13
to
170951f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goals
Reduce future import cycles, and expose more types properly, and expose an actual interface
other implementers can replace.
Implementation