Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions prompt/changelog_optization_prompt/changelog_optmization_prompt.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ CHANGELOG_CONTENT

Standardize the naming of operation groups for consistency.

#### 1.1 Added Operation Group
**Before:**
```
Added model ...Operations
Expand All @@ -28,6 +29,17 @@ Added model ...Operations
Added operation group ...Operations
```

#### 1.2 Added Method
**Before:**
```
Model ...Operations added method `...`
```

**After:**
```
Operation group ...Operations added method `...`
```

### 2. Parameter Default Value Changes

Transform default value change descriptions into more user-friendly language.
Expand Down Expand Up @@ -134,3 +146,42 @@ Rules / Constraints:
```

If multiple such lines are present, the note is still inserted only once.

### 7. Hybrid Operation Migration Note

When a method adds keyword-only ... `etag` and `match_condition` and (in the same CHANGELOG block) deletes or renames positional_or_keyword ... `if_match` and `if_none_match`, treat this as a single migration. Replace the individual add/remove lines with one concise entry.
Also, insert a hybrid operation migration note as the FIRST bullet (or line) directly under the `### Breaking Changes` heading, following the same rules/constraints of hybrid model migration note:

**Before:**
```
- Operation group `A` added parameter `etag` in method `...`
- Operation group `A` added parameter `match_condition` in method `...`
- Method `...` deleted or renamed its parameter `if_match` of kind `positional_or_keyword`
- Method `...` deleted or renamed its parameter `if_none_match` of kind `positional_or_keyword`
```

**After:**
```
- For the method breakings, please refer to https://aka.ms/azsdk/python/migrate/operations for migration.
- Method `...` replaced positional_or_keyword ... `if_match`/`if_none_match` to keyword_only ... `etag`/`match_condition`
```

Sometimes only the parameter `if_match` is removed (and `if_none_match` is not), in this case, use the single-parameter declaration below:
**Before:**
```
- Operation group `A` added parameter `etag` in method `...`
- Operation group `A` added parameter `match_condition` in method `...`
- Method `...` deleted or renamed its parameter `if_match` of kind `positional_or_keyword`
```

**After:**
```
- For the method breakings, please refer to https://aka.ms/azsdk/python/migrate/operations for migration.
- Method `...` replaced positional_or_keyword ... `if_match` to keyword_only ... `etag`/`match_condition`
```

It's often along with an entry in the `### Breaking Changes` section like:
```
- Method `...` re-ordered its parameters from `['self', '...', '...', '...', '...', 'if_match', 'if_none_match', 'kwargs']` to `['self', '...', '...', '...', '...', 'etag', 'match_condition', 'kwargs']`
```
Consider it as a fake `re-ordered` report and remove it. Don't change other `re-order` reports if it does not represent an operation migration.