Skip to content
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

Add Ask Mode Change Template #2941

Merged
merged 11 commits into from
Nov 1, 2024
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/breaking_change.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# This issue template is for use in opening issues that document breaking changes. This template should be used to create an issue by Microsoft product team members who are documenting a breaking change.
#
# Bracketed text is a placeholder; replace the text with the requested information and remove the brackets before submitting the issue. Also, remove this comment before submitting the issue.

name: "Identity Model breaking change"
description: Report a change in Identity Model that breaks something that worked in a previous version. This form is intended to be used by the product team.
title: "[Breaking change]: "
labels: "Breaking change"
body:
- type: textarea
id: description
attributes:
label: Description
description: Brief description of the breaking change.
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: What version of Identity Model introduced the breaking change?
validations:
required: true
- type: textarea
id: old-behavior
attributes:
label: Previous behavior
description: Describe the previous behavior. Include code snippets if applicable.
validations:
required: true
- type: textarea
id: new-behavior
attributes:
label: New behavior
description: Describe the new behavior. Include code snippets if applicable.
validations:
required: true
- type: checkboxes
id: change-type
attributes:
label: Type of breaking change
description: This information will be used to label the issue appropriately. [(How do I decide?)](https://learn.microsoft.com/dotnet/core/compatibility/categories)
options:
- label: "**Binary incompatible**: Existing binaries may encounter a breaking change in behavior, such as failure to load or execute, and if so, require recompilation."
- label: "**Source incompatible**: When recompiled using the new SDK or component or to target the new runtime, existing source code may require source changes to compile successfully."
- label: "**Behavioral change**: Existing binaries may behave differently at run time."
validations:
required: true
- type: textarea
id: reason
attributes:
label: Reason for change
description: Describe why the breaking change was introduced.
validations:
required: true
- type: textarea
id: recommended-action
attributes:
label: Recommended action
description: Describe the recommended action an affected user should take, such as workarounds or examples of code changes.
validations:
required: true
- type: textarea
id: affected-apis
attributes:
label: Affected APIs
description: List all the APIs affected by this change. For methods, clarify if it's all overloads or specific overloads.
placeholder: None.
validations:
required: true
Loading