suggestion: use conventional commits

openzipkin / zipkin-js

Zipkin instrumentation for Node.js and browsers

Apache License 2.0

566 stars 171 forks source link

suggestion: use conventional commits #335

Open ghermeto opened 5 years ago

ghermeto commented 5 years ago

I suggest start using conventional commits in the commit messages. This way zipkin-js can rely on automated tools to build automated and reliable change logs. Also, it makes cristal clear (and possible to automate) which should be the next version:

breaking changes are a major;
features are minor;
fixes are patches;
doc, tests, refactor and chore don't require new version and can wait;

What do you think @jcchavezs @adriancole ?

jcchavezs commented 5 years ago

I have been using the semantic commits for a while and I find it worth.

I think we could create a CONTRIBUTING.md document but it would be much better if we could also automate the red flag for non conventional commits. Do you have any experience with it?

Ping @openzipkin/zipkin-js-champions