-
Notifications
You must be signed in to change notification settings - Fork 1.1k
I add NetFx breaking-change guidance skill #14845
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
w3lld1
wants to merge
2
commits into
dotnet:main
Choose a base branch
from
w3lld1:docs/netfx-breaking-change-guidance
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| --- | ||
| name: netfx-breaking-change-guidance | ||
| description: >- | ||
| Instructions for finding, validating, and documenting WinForms behavior | ||
| changes from .NET Framework. Covers release-note labels, linked issues and | ||
| PRs, before/after behavior, affected applications, migration guidance, | ||
| compatibility switches, workaround risk, and test evidence. | ||
| metadata: | ||
| author: dotnet-winforms | ||
| version: "1.0" | ||
| --- | ||
|
|
||
| # WinForms .NET Framework Breaking-Change Guidance | ||
|
|
||
| Use this skill when a task asks for WinForms compatibility differences from | ||
| .NET Framework, breaking-change release notes, migration guidance, or updates | ||
| to issues labeled `releasenotes-breaking-change-NetFx`. | ||
|
|
||
| > **Golden rule:** Do not call a change breaking solely because behavior differs. | ||
| > Verify the .NET Framework behavior, the intended new behavior, customer impact, | ||
| > and the implementation status. Open PRs are proposals, not shipped changes. | ||
|
|
||
| ## Current tracked change | ||
|
|
||
| Refresh this section before relying on it. The inventory below reflects label | ||
| usage as of 2026-07-18. | ||
|
|
||
| ### Collection Editor movement buttons | ||
|
|
||
| - Tracking issue: dotnet/winforms#3152 | ||
| - Implementation PR: dotnet/winforms#14668 | ||
| - Label state: The PR carries `releasenotes-breaking-change-NetFx`; the issue | ||
| did not carry the label when this skill text was drafted. | ||
| - Before (.NET Framework): The Collection Editor Up and Down buttons remain | ||
| enabled at the first and last items. The handlers reject invalid moves only | ||
| after the command is invoked. | ||
| - Proposed after behavior: Up is disabled for the first item and Down is | ||
| disabled for the last item. No-selection and single-item states disable both. | ||
| - Affected scenarios: Shared design-time Collection Editor experiences, | ||
| including ImageList, ListView, TabControl, TreeView, MonthCalendar, and other | ||
| editable collections using the same form. | ||
| - Migration guidance: Application code normally needs no change. Update UI | ||
| automation, accessibility assertions, screenshots, and workflows that expect | ||
| boundary buttons to remain enabled. Do not depend on invoking an invalid | ||
| boundary command or on incidental side effects from that command. | ||
| - Evidence: The PR adds first, middle, last, no-selection, and single-item unit | ||
| coverage and has a green CI run. It remains open, so do not describe the | ||
| behavior as shipped. | ||
|
|
||
| ## Discovery workflow | ||
|
|
||
| 1. Record the as-of date. | ||
| 2. Confirm the exact label name and case in `dotnet/winforms`. | ||
| 3. Search issues and PRs separately for | ||
| `releasenotes-breaking-change-NetFx`; GitHub search otherwise mixes both. | ||
| 4. For every labeled item, identify its tracking issue, implementation PR, | ||
| target release, current state, and relevant commit. | ||
| 5. Read the complete issue and PR discussion, source diff, tests, reviews, and | ||
| CI results. | ||
| 6. Reproduce or verify the .NET Framework behavior from reference source, a | ||
| targeted test application, historical tests, or authoritative documentation. | ||
| 7. Separate these categories: | ||
| - regression fix restoring .NET Framework behavior; | ||
| - intentional divergence from .NET Framework; | ||
| - long-standing bug fix that may break customer workarounds; | ||
| - implementation-only change with no observable compatibility impact. | ||
| 8. Never fabricate an entry when the label search is empty. | ||
|
|
||
| ## Required documentation for each change | ||
|
|
||
| Every entry must contain: | ||
|
|
||
| - linked tracking issue and implementation PR; | ||
| - current state and target .NET version; | ||
| - **Before (.NET Framework)** behavior; | ||
| - **After (.NET)** behavior; | ||
| - affected controls, designers, applications, and scenarios; | ||
| - source compatibility, binary compatibility, and behavioral compatibility; | ||
| - known customer workarounds that may regress; | ||
| - migration or mitigation guidance; | ||
| - compatibility switch or opt-out, or an explicit statement that none exists; | ||
| - unit, integration, manual, and CI evidence; | ||
| - uncertainty and missing comparison evidence. | ||
|
|
||
| ## Writing guidance | ||
|
|
||
| - Lead with the observable behavior change, not implementation details. | ||
| - State whether action is required and who is affected. | ||
| - Prefer a minimal before/after example when it clarifies impact. | ||
| - Distinguish an open proposal from merged, preview, and shipped behavior. | ||
| - If a fix can invalidate common workarounds, also consider the | ||
| `releasenotes-may-break-workaround` label. | ||
| - Keep the skill inventory synchronized with release notes and compatibility | ||
| documentation when a PR merges, changes shape, or is abandoned. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "Use this skill" paragraph should be moved into the front matter description field, but it shouldn't instruct the model to "use this skill explicitly." The description is the metadata that the harness agent uses to determine whether the skill should be loaded into the context window.