vstest-docs icon indicating copy to clipboard operation
vstest-docs copied to clipboard

Adopt a changelog style guide

Open vweevers opened this issue 3 years ago • 0 comments

Would you consider adopting a changelog style guide, like Keep A Changelog or Common Changelog? This would help to categorize the changes and make it easy to parse for humans.

In the current release notes, the Issues Fixed section lists all kinds of changes: new features, bug fixes, security vulnerabilities and more. As a consumer (of Microsoft.NET.Test.Sdk in my case) that makes it difficult to determine 1) should I upgrade and 2) can I upgrade?

In addition, what does "drop" mean? As used here:

https://github.com/microsoft/vstest-docs/blob/d8178d8a81c9e9bed53aca8f49a1a82dcdffd669/docs/releases.md#L10-L13

I reckon it means an artifact published to VSDrop (an internal MS tool?). That's unclear at first glance, because the headers "Issues Fixed" and "Drops" are at the same level, which could also suggest that "Drops" lists removed features. And the term "drop" seems to be an internal MS term, which makes it less suitable for use in public release notes.

vweevers avatar Sep 26 '22 11:09 vweevers