Release Notes Template

Jump to bottom

Maciek Grzybowski edited this page Jul 9, 2020 · 2 revisions

<if the release bring a significant update, point it here in one or two short sentences>

(optional) Features

<one by one, new features - give PR reference and (if appropriate) the Issue reference with thanks to community members)>
<e.g.: "foo.bar() API is introduced, to help with foo (#<PR.id>), solves #<Issue.id> (thanks @<community.member>)">

(optional) Bug Fixes

<one by one, bug fixes - give the PR reference and (if appropriate) the Issue reference with thanks to community members)>
<e.g.: "foo.bar() API is fixed (#<PR.id>), solves #<Issue.id> (thanks @<community.member>)">

(optional) Improvements

<one by one, improvements - give the PR reference and (if appropriate) the Issue reference with thanks to community members)>
<e.g.: "foo.bar() API is improved (#<PR.id>), solves #<Issue.id> (thanks @<community.member>)">

(optional) Other Changes

<one by one, other user-facing changes - give the PR reference and (if appropriate) the Issue reference with thanks to community members)>
<e.g.: "foo.bar() API is improved (#<PR.id>), solves #<Issue.id> (thanks @<community.member>)">

(optional) Upgrade From `x.y.z`

<one by one list of steps for upgrading from x.y.z- keep it short, give references to PRs bringing the change, short and condensed code snippets are welcome (use details/summary blocks to keep it condensed)>

See details

<Reference to public docs if any, e.g. "More in iOS Trace Collection guide.">

(optional) Eventual Breaking Changes in X, Y and Z

<describe breaking change, keep it short, use details/summary blocks>

See details