You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/agents/bug-fixing-orchestrator-agent.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ handoffs:
31
31
send: false
32
32
- label: "5. Update Changelog"
33
33
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."
35
35
send: false
36
36
---
37
37
@@ -166,7 +166,7 @@ Use agents in this order:
166
166
2.**`bug-fixing-implementer-agent`** — implements the minimum fix
167
167
3.**`component-readme-agent`** — only if public API or documented behavior changed
168
168
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
Copy file name to clipboardExpand all lines: .github/agents/changelog-agent.md
+14-9Lines changed: 14 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
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.
4
4
tools:
5
5
- search/codebase
6
6
- edit/editFiles
@@ -9,7 +9,7 @@ tools:
9
9
10
10
# Changelog Agent
11
11
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.
13
13
14
14
---
15
15
@@ -24,12 +24,15 @@ Open `CHANGELOG.md` and locate the **first `## <version>` heading** — that's t
24
24
| Change type | Subsection |
25
25
|---|---|
26
26
| New feature |`### New Features`|
27
-
| Bug fix |`### Bug Fixes`|
27
+
| Deprecation |`### General`|
28
+
| Behavioral change |`### General`|
29
+
| Notable user-visible fix |`### General`|
28
30
| Breaking change |`### Breaking Changes`|
29
-
| Deprecation or behavioral change |`### General`|
30
31
| i18n / localization |`### Localization(i18n)`|
31
32
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.
33
36
34
37
### 3. Write the Entry
35
38
@@ -47,7 +50,9 @@ If the subsection exists, append to it. If not, create it following this order:
47
50
- Added `propertyName` input that allows <whatitdoes>.
48
51
```
49
52
50
-
#### Bug Fixes
53
+
#### General
54
+
55
+
Use `### General` for changelog-worthy bug fixes.
51
56
52
57
```markdown
53
58
-`IgxComponentName`
@@ -92,14 +97,14 @@ Before finishing:
92
97
93
98
### 5. Commit
94
99
95
-
For features and deprecations:
100
+
For features:
96
101
```
97
102
docs(<component>): update CHANGELOG for <feature-name>
98
103
```
99
104
100
-
For bug fixes:
105
+
For `General` entries, including deprecations and changelog-worthy bug fixes:
101
106
```
102
-
docs(<component>): update CHANGELOG for <bug-fix-description>
107
+
docs(<component>): update CHANGELOG for <general-change-description>
103
108
```
104
109
105
110
For breaking changes, include `BREAKING CHANGE:` in the commit body:
0 commit comments