|
| 1 | +When you're assigned an issue that's labeled "breaking-change", or when you're given a link to an issue that's labeled "breaking-change" and asked to create a new breaking change document, follow the following guidelines: |
| 2 | + |
| 3 | +The document should be in Markdown format. |
| 4 | + |
| 5 | +.NET Aspire breaking changes live in the https://github.com/dotnet/docs-aspire/tree/main/docs/compatibility folder and its subfolders. |
| 6 | + |
| 7 | +Rephrase all content to be clear and concise, if necessary. |
| 8 | + |
| 9 | +Describe previous behavior in past tense and new behavior in present tense. |
| 10 | + |
| 11 | +The document should start with the following frontmatter, including `---` characters. Placeholder text is shown in angle brackets. |
| 12 | + |
| 13 | + --- |
| 14 | + title: "Breaking change - <A concise descriptive title of the breaking change>" |
| 15 | + description: "Learn about the breaking change in <product/version without the preview number> where <very brief description>." |
| 16 | + ms.date: <Today's date> |
| 17 | + ai-usage: ai-assisted |
| 18 | + ms.custom: <URL of the GitHub issue> |
| 19 | + --- |
| 20 | + |
| 21 | +After the frontmatter, include the following sections in this order. Use the description in parentheses as a guide for the content of each section. |
| 22 | + |
| 23 | +h1: "(The same title used in the document header, sans 'Breaking Change - ')" |
| 24 | + |
| 25 | + (An introductory paragraph summarizing the breaking change. Include the major version but not the preview number.) |
| 26 | + |
| 27 | +h2: Version introduced |
| 28 | + |
| 29 | + (The version in which the breaking change was introduced. Include the preview number here, if given.) |
| 30 | + |
| 31 | +h2: Previous behavior |
| 32 | + |
| 33 | + (A brief description of the behavior before the change, including an example code snippet if applicable.) |
| 34 | + |
| 35 | +h2: New behavior |
| 36 | + |
| 37 | + (A brief description of the behavior after the change, including an example code snippet if applicable.) |
| 38 | + |
| 39 | +h2: Type of breaking change |
| 40 | + |
| 41 | + If the type of breaking change is "behavioral change", add the following sentence (without the backticks): `This is a [behavioral change](../../categories.md#behavioral-change).` |
| 42 | + |
| 43 | + If the type of breaking change is "source incompatible" or "binary incompatible", add the following sentence (without the backticks): `This change can affect [source compatibility](../../categories.md#source-compatibility).` or `This change can affect [binary compatibility](../../categories.md#binary-compatibility).` |
| 44 | + |
| 45 | + If the issue lists multiple types of breaking changes, create a single sentence that links to each applicable type, such as "This is both a []() and []() change.". If there is no type of breaking change selected in the issue, write "TODO: Add type of breaking change." |
| 46 | + |
| 47 | +h2: Reason for change |
| 48 | + |
| 49 | + (The complete reasoning behind the change, including any relevant links.) |
| 50 | + |
| 51 | +h2: Recommended action |
| 52 | + |
| 53 | + (A brief description of the action or actions that users should take, including example code snippets if applicable.) |
| 54 | + |
| 55 | +h2: Affected APIs |
| 56 | + |
| 57 | + (A bullet list of APIs that are affected by the change. If there are no affected APIs (or "No response") write "None.". Use xref-style links as described in the copilot-instructions.md file. At the end of each doc ID, add "?displayProperty=fullName", for example "<xref:System.String?displayProperty=fullName>".) |
| 58 | + |
| 59 | +Then, add the new document to both the "By area" and "By version" sections of the TOC file located at https://github.com/dotnet/docs-aspire/tree/main/docs/compatibility/toc.yml. Also add an entry to the index file under the appropriate area H2 heading in the https://github.com/dotnet/docs-aspire/tree/main/docs/compatibility/9.3/index.md file by adding a row to the table (create a new heading/table if it doesn't exist yet). |
| 60 | + |
| 61 | +Next, create a pull request. In the description, include the text "Fixes #\<issue-number>", where "issue-number" is the GitHub issue number. |
0 commit comments