Skip to content

Commit

Permalink
Identify renaming a parameter set as non-breaking in the breaking cha…
Browse files Browse the repository at this point in the history
…nge contract document (#10113)

* Identify renaming a parameter set as non-breaking
Related discussion: #10058.

* Add note about S.M.A.Internal
  • Loading branch information
KirkMunro authored and iSazonov committed Jul 15, 2019
1 parent 0ae7d50 commit c752694
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/dev-process/breaking-change-contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,9 @@ Changes to surface area or behavior that is clearly internal or non-breaking in

Examples:

+ Changes to internal APIs that break private reflection
+ Changes to internal APIs that break private reflection.
+ Changes to APIs in the `System.Management.Automation.Internal` namespace (even if they are public, they are still considered internal and subject to change).
+ Renaming a parameter set (see related discussion [here](https://github.com/PowerShell/PowerShell/issues/10058)).

It is impossible to evolve a code base without making such changes, so we don't require up-front approval for these, but we will sometimes have to go back and
revisit such change if there's too much pain inflicted on the ecosystem through a popular app or library.
Expand Down

0 comments on commit c752694

Please sign in to comment.