-
Notifications
You must be signed in to change notification settings - Fork 344
Conversation
In the same manner as the golang changelog: https://github.com/opentracing/opentracing-go/blob/master/CHANGELOG.md
CHANGELOG.md
Outdated
@@ -0,0 +1,13 @@ | |||
Changes by Version | |||
================== |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could be used the same formatting symbols as in other markdown files in this repository. e.g. #
for headers, *
for lists
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was trying to be uniform by copying the style in the go CHANGELOG ;) : https://raw.githubusercontent.com/opentracing/opentracing-go/master/CHANGELOG.md\
We also use .rst
instead of .md
in some repos. 🤷♂️
I prefer #
and *
so I'll switch to that. Maybe we can standardize and change the others as part of the upcoming "language maintainer" initiative.
CHANGELOG.md
Outdated
================== | ||
|
||
v0.31.0 (2018-01-12) | ||
-------------------- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we add one list item per added change? All the following would be in the one list item. Also, add a link to the PR, in some projects there is also a name of the commiter.
Two major changes are missing there:
- introduction of log fields
- removed
span.log(object)
methods
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure what you mean by "All the following would be in the one list item." Do you mean only one list item for all the Scope/ActiveSpan changes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes as it was part of one PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I looked though the PRs... unfortunately I don't think the Pull Requests line up cleanly, as we went through many revisions. I will try to find a middle ground.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Besides Pavol's remarks, I'd also mention that:
- We have deprecated startManual() in favor of start().
- Added an examples directory.
- Maybeeee mention MockTracer uses TEXT_MAP as its default propagator, and added multi support reference.
should we adopt the http://keepachangelog.com/en/1.0.0/ format? |
@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... |
@pavolloffay @carlosalberto @yurishkuro I updated this PR, sorry for the delay.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Were there any other minor API changes, like in the tags?
LGTM, although at least one minor yet important thing is missing. Removed |
I will merge this and open subsequent PR to add more links in there. |
In the same manner as the golang changelog: https://github.com/opentracing/opentracing-go/blob/master/CHANGELOG.md