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
- BAD: "Edit label UI does not resize on graph zoom"
134
+
- GOOD: "Fix edit label UI not resizing on graph zoom"
135
+
- Keep concise — one line
125
136
126
137
**Breaking changes:**
127
-
- Describe what changed, why it's breaking, and how to migrate
128
-
- Extract migration sub-items from the PR body's "What it does" section
138
+
139
+
- Describe what changed, why it's breaking, and how to migrate
140
+
- Extract migration sub-items from the PR body's "What it does" section
129
141
130
142
---
131
143
@@ -136,13 +148,15 @@ Pick the most fitting tag from the vocabulary (Step 1.2) based on PR title and b
136
148
Read `CHANGELOG.md` in the repository root.
137
149
138
150
**Active section detection:**
139
-
- An active section has the `- active` suffix (e.g. `## v2.7.0 - active`)
140
-
- If an active section exists → merge new entries into it
141
-
- If the topmost section is a released version (no `- active` suffix) → create a new active section above it
151
+
152
+
- An active section has the `- active` suffix (e.g. `## v2.7.0 - active`)
153
+
- If an active section exists → merge new entries into it
154
+
- If the topmost section is a released version (no `- active` suffix) → create a new active section above it
142
155
143
156
**Creating a new section:**
144
-
- Bump the minor version of `LAST_TAG` (e.g. `v2.6.0` → `v2.7.0`)
145
-
- Insert after the title line, before the first `## ` heading:
157
+
158
+
- Bump the minor version of `LAST_TAG` (e.g. `v2.6.0` → `v2.7.0`)
159
+
- Insert after the title line, before the first `## ` heading:
146
160
147
161
```markdown
148
162
## v2.7.0 - active
@@ -160,9 +174,10 @@ Read `CHANGELOG.md` in the repository root.
160
174
Only include "Potentially Breaking Changes" if there are breaking entries.
161
175
162
176
**Merging into existing active section:**
163
-
- Check PR numbers against existing entries to avoid duplicates
164
-
- Append new entries to the appropriate subsection
165
-
- Create missing subsections as needed
177
+
178
+
- Check PR numbers against existing entries to avoid duplicates
179
+
- Append new entries to the appropriate subsection
180
+
- Create missing subsections as needed
166
181
167
182
### Step 2.2: Write the updated CHANGELOG.md
168
183
@@ -185,13 +200,14 @@ Present the diff to the user.
185
200
List any entries flagged as uncertain (category or breaking status) and ask the user to resolve them.
186
201
187
202
Even if nothing is uncertain, ask:
203
+
188
204
> "Does everything look correct, or would you like to adjust any entries?"
189
205
190
206
### Step 3.3: Collect user feedback
191
207
192
-
-**Approve as-is** → done (or proceed to Phase 4 if PR was requested)
193
-
-**Request edits** → apply changes, show updated diff, ask again
194
-
-**Resolve uncertain items** → apply, show updated diff
208
+
-**Approve as-is** → done (or proceed to Phase 4 if PR was requested)
209
+
-**Request edits** → apply changes, show updated diff, ask again
210
+
-**Resolve uncertain items** → apply, show updated diff
195
211
196
212
**Do NOT proceed to Phase 4 unless the user explicitly requests a PR.**
197
213
@@ -200,11 +216,13 @@ Even if nothing is uncertain, ask:
200
216
## Phase 4: PR Creation (Optional)
201
217
202
218
Only execute this phase if the user explicitly requests a PR (either in their initial prompt or after reviewing the changelog). If the user hasn't mentioned a PR, ask after approval:
219
+
203
220
> "Would you like me to create a PR for this changelog update, or are you done?"
204
221
205
222
### Step 4.1: Determine the branch name
206
223
207
224
Check if `changelog-update` exists on remote:
225
+
208
226
```bash
209
227
git ls-remote --heads origin changelog-update
210
228
```
@@ -229,6 +247,7 @@ Report the PR URL.
229
247
### Step 4.4: Label referenced PRs
230
248
231
249
Add the `changelog` label to every PR mentioned in the new entries:
0 commit comments