Skip to content
This repository has been archived by the owner on Dec 5, 2022. It is now read-only.
This repository has been archived by the owner on Dec 5, 2022. It is now read-only.

Adopt a changelog style guide #269

Open

Description

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:

### Drops
* TestPlatform vsix: [17.3.2](https://vsdrop.corp.microsoft.com/file/v1/Products/DevDiv/microsoft/vstest/17.3/20220919-01;/TestPlatform.vsix)
* Microsoft.TestPlatform.ObjectModel : [17.3.2](https://www.nuget.org/packages/Microsoft.TestPlatform.ObjectModel/17.3.2)

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions