Giter Site home page Giter Site logo

Comments (6)

pichlermarc avatar pichlermarc commented on July 28, 2024

I usually write dash -, and since most parts of the repo & contrib seem to be using that. So I'm in favor of aligning it to dash. 🙂

from opentelemetry-js.

blumamir avatar blumamir commented on July 28, 2024

I usually write dash -, and since most parts of the repo & contrib seem to be using that. So I'm in favor of aligning it to dash. 🙂

Thanks @pichlermarc . Do you suggest we do it only for READMEs, or to all markdown files in the codebase? (including CHANGELOG)

from opentelemetry-js.

trentm avatar trentm commented on July 28, 2024

Note that the CHANGELOG in the contrib repo is currently generated by release-please which is using *. Not sure if that is changeable.

I'm on team dash, but I'm also not sure how important it is to enforce. I'm easy.

from opentelemetry-js.

blumamir avatar blumamir commented on July 28, 2024

I'm on team dash, but I'm also not sure how important it is to enforce. I'm easy.

I was trying to aggregate data from the READMEs of multiple instrumentations into single markdown, and then we use mixed style and needs to be corrected. Was thinking that it is better to be aligned upstream instead of modifying tools to correct styling downstream in distributions.

created open-telemetry/opentelemetry-js-contrib#2205 to apply in contrib, and will create one for core as well

from opentelemetry-js.

JamieDanielson avatar JamieDanielson commented on July 28, 2024

Also team dash generally, but fine with asterisks. I don't feel strongly except to have consistency of using one or the other, so any move in favor of consistency is something I'm on board with 👍

from opentelemetry-js.

blumamir avatar blumamir commented on July 28, 2024

fixed in #4713

from opentelemetry-js.

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.