Add a CHANGELOG file - Githubissues

opentracing / opentracing-java

OpenTracing API for Java. 🛑 This library is DEPRECATED! https://github.com/opentracing/specification/issues/163

http://opentracing.io

Apache License 2.0

1.68k stars 344 forks source link

Add a CHANGELOG file #251

Closed tedsuo closed 6 years ago

tedsuo commented 6 years ago

In the same manner as the golang changelog: https://github.com/opentracing/opentracing-go/blob/master/CHANGELOG.md

coveralls commented 6 years ago

Coverage remained the same at 81.515% when pulling a47aa4446e14d052b6801c1bf4f30210722b2197 on tedsuo/add-changelog into 242ba956368c48b804ae4120053955a49f7f9c63 on master.

yurishkuro commented 6 years ago

should we adopt the http://keepachangelog.com/en/1.0.0/ format?

tedsuo commented 6 years ago

@yurishkuro http://keepachangelog.com/en/1.0.0/ seems nice but I'd like to get a language maintainer group together to start making these decisions. There's a set of things we should standardize on, such as PR/Issue templates, release procedures, etc...

tedsuo commented 6 years ago

@pavolloffay @carlosalberto @yurishkuro I updated this PR, sorry for the delay.

Switched to more standard markdown syntax.
The PRs in the v0.31 were too messy to reference, as a result of numerous revisions, so I did not include them.
We could include a link to the tracking issue, but I'm not sure how helpful that is (https://github.com/opentracing/opentracing-java/issues/189)
Instead I simplified the line items to objects which were added and removed from the core API, and method changes on the Tracer object. Hopefully that's the right level of detail.

pavolloffay commented 6 years ago

LGTM, although at least one minor yet important thing is missing. Removed log.(Object) methods.

pavolloffay commented 6 years ago

I will merge this and open subsequent PR to add more links in there.