Rewrite changelog - Githubissues

TwicPics / components

A Web component library that brings the power of TwicPics to your favorite web framework.

MIT License

53 stars 2 forks source link

Rewrite changelog #9

Closed Strift closed 2 years ago

Strift commented 2 years ago

I rewrote the changelog to make it a bit more user-friendly following the Keep a changelog guidelines.

Some notes on the formatting:

used backquotes for code, not keywords
used bold for keywords like Vue, React, etc.
used bold for breaking changes

What do you think? Let me know if you have comments!

jaubourg commented 2 years ago

I'm globally curious what the benefits of the new format is. Is it simply cosmetic or is this format so widely used it is a de-facto standard?

Strift commented 2 years ago

Hey @jaubourg :wave:

I don't know if it is that widely used in the industry, but I've seen it in the frameworks I personally use: Vue.js, Laravel, and TailwindCSS.

So benefits are:

cosmetics (not even gonna lie :see_no_evil:)
writing guidelines (so we don't have to write and maintain in-house)

Obviously, using something documented which is also a bit known in the industry will facilitate the onboarding of open-source contributors, which is a plus.