Skip to content

Commit 3a3a0b5

Browse files
authored
Update breaking-change-guidelines.md (#47797)
2 parents f795614 + cb9b9b8 commit 3a3a0b5

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

documentation/project-docs/breaking-change-guidelines.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ This document provides guidelines for introducing new diagnostics or breaking ch
44

55
## General guidance
66

7-
In general, we want to make updating the .NET SDK as smooth as possible for developers. This means:
7+
In general, we want to make updating the .NET SDK as smooth as possible for developers. This extends to .NET tooling such as IDEs and code editors which may have a different release schedule and cadence. For example, the .NET 9 SDK (which was a new major version) was released with Visual Studio 17.12 (which was a new minor version). In this example, breaking changes in the .NET 9 SDK could disproportionally impact Visual Studio users who are expecting incremental, non-breaking, changes in the new minor version. Same applies to other IDEs and code editors from the wider .NET community.
88

9+
This means:
910
* Introducing new changes in a staged/gradual way.
1011
* Tying new analyzers/diagnostics to a mechanism that requires explicit opt-in.
1112
* Providing a way to opt out of a change entirely.
@@ -84,5 +85,5 @@ Specific example: NuGet warnings for vulnerable transitive dependencies were int
8485

8586
* Create an issue in the appropriate GitHub repository to track the change, if one does not already exist.
8687
* Add the breaking-change label to the issue. This label should be available in all .NET repositories that ship as part of the .NET SDK. If the label is not available, please file an issue in [dotnet/sdk](https://github.com/dotnet/sdk).
87-
* The issue will trigger a message with instructions to add documentation. In addition, you are invited to work with the SDK team to publish a blog post for the change.
8888
* Consider creating and pinning an issue in the appropriate GitHub repository where the community can provide feedback.
89+
* Once a Pull Request is submitted for the issue, add the breaking-change label to the Pull Request as well. This will trigger a message with instructions. In addition, you are invited to work with the SDK team to publish a blog post for the change.

0 commit comments

Comments
 (0)