search

ipfs / go-cid

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

Needs README #5

Closed RichardLitt closed 7 years ago

RichardLitt commented 8 years ago

@hsanjuan Do you understand enough of this module to add more than the skeleton readme I would provide?

hsanjuan commented 8 years ago

Nope. Plus I think it's the repo's captain job to spend the time creating some documentation when a new repo is created (maybe 5 minutes for this) and taking upon such responsibilities on something that I'm not involved in would set a bad example and perpetuate bad practices.

RichardLitt commented 8 years ago

Alright! Thanks, @hsanjuan.

whyrusleeping commented 8 years ago

Hey @RichardLitt and @hsanjuan I think it would be a great learning exercise for the two of you to read and understand the cid spec well enough that you can create a moderately informative readme for this repo. I can of course create such a readme myself, but doing so would prevent two core team members from taking the extra time to get a good understanding of a critical piece of our project.

hsanjuan commented 8 years ago

I disagree @whyrusleeping . I don't want you to use "learning exercise for new members" as an excuse for leaving your code undocumented. Doing it yourself would not prevent me from taking the extra time when I need to/if I want to. In fact, it would make the project more attractive to look at :).

Writing the README for you would prevent an experienced member of the core team from taking the extra time to be exemplary to the rest of us. That includes docs, even if they're boring to produce.