Giter Club home page Giter Club logo

Comments (3)

daviddias avatar daviddias commented on May 18, 2024

IETF RFCs add a section at the beginning saying that X Y and Z should be interpreted as described by some other spec, so that there isn't anything ambiguous. I like what it offers but dislike the implementation cause it is too verbose.

An idea:

Each time there is a word that has a meaning on the standard-readme space, you could add a special char (like ⊛) and add a link to this repo, on the section that describes that word meaning in the context.

from standard-readme.

RichardLitt avatar RichardLitt commented on May 18, 2024

Hmm. I was not clear enough.

I mean, should there be justifications for decisions made in sections - not in the case of confusing terminology, but in the case of "Why did you put the Contribute section here?", or, "Why README and not readme?" This could also be discussed in the issues, and perhaps that is a better place to do it.

from standard-readme.

RichardLitt avatar RichardLitt commented on May 18, 2024

I am going to not do this. I think that any questions can happen in the issues, and trying to a priori predict them is bound to be suboptimal.

from standard-readme.

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.