Skip to content

Commit aabd77f

Browse files
refactor(changelog): clarify conditions for updating CHANGELOG.md entries
1 parent f4f70df commit aabd77f

2 files changed

Lines changed: 16 additions & 11 deletions

File tree

.github/agents/bug-fixing-orchestrator-agent.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ handoffs:
3131
send: false
3232
- label: "5. Update Changelog"
3333
agent: changelog-agent
34-
prompt: "Read the changes made and update CHANGELOG.md to reflect the bug fix, breaking change, or behavioral change."
34+
prompt: "Read the changes made and update CHANGELOG.md only if the fix belongs under an existing CHANGELOG section. Otherwise leave CHANGELOG.md unchanged."
3535
send: false
3636
---
3737

@@ -166,7 +166,7 @@ Use agents in this order:
166166
2. **`bug-fixing-implementer-agent`** — implements the minimum fix
167167
3. **`component-readme-agent`** — only if public API or documented behavior changed
168168
4. **`migration-agent`** — only if the fix introduces a breaking change
169-
5. **`changelog-agent`**updates CHANGELOG.md
169+
5. **`changelog-agent`**only if the fix warrants an entry under an existing CHANGELOG sections; otherwise leave `CHANGELOG.md` unchanged
170170

171171
### Step 4 — Verify Completeness
172172

.github/agents/changelog-agent.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: changelog-agent
3-
description: Updates CHANGELOG.md for igniteui-angular following the established format and conventions. Handles new features, bug fixes, breaking changes, deprecations, and behavioral changes.
3+
description: Updates CHANGELOG.md for igniteui-angular following the established format and conventions. Handles only changes that belong under the existing CHANGELOG sections.
44
tools:
55
- search/codebase
66
- edit/editFiles
@@ -9,7 +9,7 @@ tools:
99

1010
# Changelog Agent
1111

12-
You update `CHANGELOG.md` at the repository root for Ignite UI for Angular. Every new feature, bug fix, deprecation, breaking change, or behavioral change must be documented.
12+
You update `CHANGELOG.md` at the repository root for Ignite UI for Angular. Only add entries that fit the existing section structure already used in the file. Do not invent new section types.
1313

1414
---
1515

@@ -24,12 +24,15 @@ Open `CHANGELOG.md` and locate the **first `## <version>` heading** — that's t
2424
| Change type | Subsection |
2525
|---|---|
2626
| New feature | `### New Features` |
27-
| Bug fix | `### Bug Fixes` |
27+
| Deprecation | `### General` |
28+
| Behavioral change | `### General` |
29+
| Notable user-visible fix | `### General` |
2830
| Breaking change | `### Breaking Changes` |
29-
| Deprecation or behavioral change | `### General` |
3031
| i18n / localization | `### Localization(i18n)` |
3132

32-
If the subsection exists, append to it. If not, create it following this order: `New Features``Bug Fixes``General``Breaking Changes``Localization(i18n)`.
33+
If a bug fix deserves a release note because it is a notable user-visible behavior change, place it under `### General` and match the existing wording style.
34+
35+
If the needed subsection exists, append to it. If not, create that subsection only if it is one of the allowed subsection types above.
3336

3437
### 3. Write the Entry
3538

@@ -47,7 +50,9 @@ If the subsection exists, append to it. If not, create it following this order:
4750
- Added `propertyName` input that allows <what it does>.
4851
```
4952

50-
#### Bug Fixes
53+
#### General
54+
55+
Use `### General` for changelog-worthy bug fixes.
5156

5257
```markdown
5358
- `IgxComponentName`
@@ -92,14 +97,14 @@ Before finishing:
9297

9398
### 5. Commit
9499

95-
For features and deprecations:
100+
For features:
96101
```
97102
docs(<component>): update CHANGELOG for <feature-name>
98103
```
99104

100-
For bug fixes:
105+
For `General` entries, including deprecations and changelog-worthy bug fixes:
101106
```
102-
docs(<component>): update CHANGELOG for <bug-fix-description>
107+
docs(<component>): update CHANGELOG for <general-change-description>
103108
```
104109

105110
For breaking changes, include `BREAKING CHANGE:` in the commit body:

0 commit comments

Comments
 (0)