ipfs / go-cid

Content ID v1 implemented in go
MIT License
157 stars 47 forks source link

consider moving _rsrch/cidiface to internal #168

Closed MichaelMure closed 1 month ago

MichaelMure commented 1 month ago

As I understand, _rsrch/cidiface is an engineering experiment package to explore the right form for a CID. As such, it's not meant to be actually used, and could result in conflict if used. There is definitely value in that package, if only to document design choices.

My (admittedly little) issue is that my IDE keeps suggesting me to import that package, and sometimes does. It would be way less confusing for everyone if _rsrch/cidiface would be moved into internal/_rsrch/cidiface or something similar.

welcome[bot] commented 1 month ago

Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review. In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additional round trips is useful! We currently aim to give initial feedback within two business days. If this does not happen, feel free to leave a comment. Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:

Finally, remember to use https://discuss.ipfs.io if you just need general support.

gammazero commented 1 month ago

Sounds like a good idea. PR would be great. Either move it to internal or remove it if no longer needed.

MichaelMure commented 1 month ago

@gammazero here is the PR: https://github.com/ipfs/go-cid/pull/169