Code Monkey home page Code Monkey logo

Comments (4)

hsanjuan avatar hsanjuan commented on July 21, 2024 1

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.

from go-cid.

RichardLitt avatar RichardLitt commented on July 21, 2024

Alright! Thanks, @hsanjuan.

from go-cid.

whyrusleeping avatar whyrusleeping commented on July 21, 2024

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.

from go-cid.

hsanjuan avatar hsanjuan commented on July 21, 2024

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.

from go-cid.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.