template

Release Notes Template

// Double forward slash represent comments to the author for directions // Brackets {} represent placeholders for content to be filled in // If statements represent the context of the type of release note or issue tracking tool the team uses

{Product Name} {version}

Last Update: {mm/dd/yyyy}

Getting Started | What's New | Known Issues | Blogs | Feedback | Open Source

Requirements

// Only include if there are new requirements needed for the release or features of the release // List any new requirements for this release such as a new version of Java, Android SDK Tool Version, XCode, Mac Version, etc.

What's New in this Release

// List out all new features or enhancements that were changed. Include links inline if applicable to docs, etc. // This summary area is for a short one-liner

• New Feature is really exciting
• Another new change is awesome

//This detailed area is for a longer description per each item

{Title of Feature or Change}

{Paragraph detailing the feature or change} {Images if applicable} {Links to docs or guides "For More on...."}

Notable Changes

// List out notable bug fixes and include links inline if applicable. // These should be issues submitted by users or have a higher impact on users.

Release History

// List out current and previous minor version History //Example: October 9th, 2017 - Xamarin.Android 8.0.0.33

• {Month} {Day}, {Year} - {Product Name} {version}
• {Month} {Day}, {Year} - {Product Name} {version}
• {Month} {Day}, {Year} - {Product Name} {version}

You can learn more about how we ship our releases in the Visual Studio 2017 Release Rhythm document.

// Release details sections are listed below with the most recent release listed first. // Template:

{Month} {Day}, {Year} - {Product Name} {version}

{if stable}

This version is included in the Visual Studio 2017 version {version} release. //Example: This version is included in the Visual Studio 2017 version 15.4 release. //Service Releases should be depicted as {version.sr} //Example: This version is included in the Visual Studio 2017 version 15.4.2 release.

{if preview}

This version is included in the Visual Studio 2017 version {version + Preview (N)} release. //Example: This version is included in the Visual Studio 2017 version 15.5 Preview 2 release.

Issues Fixed

• {Bugzilla Number}: {Title of the bug}
• {DevCom Title}

Breaking Changes

• {Bugzilla Number}: {Title of the bug}
• {DevCom Title}

Integrated Mono Features/Fixes

{Product} uses {Mono Version} {commit number}.

• {Bugzilla Number}: {Title of the bug}

Known Issues

// These should be defined as a KNOWN ISSUE.

{Title}

{Paragraph detailing known issue} {Links to respective bug or devcom item}

{API Changes / API Diff}

// API Changes are different per products as some products only have one major binding to diff. Others have multiple.

• {API Change}

Feedback

{if non-vsts} Your feedback is important to us. If there are any problems with this release, check the {Product} Forums and Xamarin Bugzilla Tracker for existing issues. If you do not find any matching issue, please feel free to start a new discussion and report an issue.

{if vsts} Your feedback is important to us. If there are any problems with this release, check the {Product} Forums, Xamarin Bugzilla Tracker, and Developer Community for existing issues. If you do not find any matching issue, please feel free to start a new discussion and report a problem.

Open Source

// Each product may want to word how they manage open source. Feel free to do what you will with this section.

{Product + version} is based on the open-source {product} repositories:

• {Repository Name}