Skip to content

Commit da6afd1

Browse files
Bump version to 2.3.6 (#1354)
1 parent 5f523eb commit da6afd1

File tree

2 files changed

+72
-21
lines changed

2 files changed

+72
-21
lines changed

.cursor/skills/changelog-cleanup/SKILL.md

Lines changed: 71 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,71 +2,122 @@
22
name: changelog-cleanup
33
description: >-
44
Analyze and clean up the Upcoming Release section in CHANGELOG.md. Reviews
5-
each entry for grammar and logic issues, then sorts entries into categories.
6-
Use when the user mentions changelog cleanup, changelog sorting, release
7-
notes review, or preparing a release.
5+
each entry for grammar and logic issues, then sorts entries into named
6+
sections. Use when the user mentions changelog cleanup, changelog sorting,
7+
release notes review, or preparing a release.
88
---
99

1010
# Changelog Cleanup
1111

1212
Cleans up the `## Upcoming Release` section of `CHANGELOG.md` in two phases:
13-
grammar/logic review, then sorting by category.
13+
grammar/logic review, then sorting into named sections.
14+
15+
## Changelog structure
16+
17+
Each release is a `## ` heading (e.g., `## Upcoming Release`, `## 2.3.6`).
18+
Within a release, entries are organized under **named sections** — plain-text
19+
labels followed by a colon, each followed by a blank line and then bullet
20+
entries. Section names are **not fixed**; they vary between releases. Common
21+
examples include `New features:`, `Changes:`, `Bugfixes:`, but there may be
22+
others (e.g., `Deprecations:`, `Breaking changes:`, `Performance:`).
23+
24+
Example structure:
25+
26+
```markdown
27+
## 2.3.6
28+
29+
New features:
30+
31+
- Entry one
32+
33+
Changes:
34+
35+
- Entry two
36+
37+
Bugfixes:
38+
39+
- Entry three
40+
- Entry four
41+
```
42+
43+
Older releases (before 2.3.6) use a legacy flat list of bullets with no named
44+
sections. That format is no longer valid for new releases.
1445

1546
## Phase 1: Grammar and Logic Review
1647

17-
1. Read `CHANGELOG.md` and extract all entries under `## Upcoming Release`
48+
1. Read `CHANGELOG.md` and extract all content under `## Upcoming Release`
1849
(stop at the next `## ` heading).
1950
2. For each entry, check for:
2051
- Spelling and grammar mistakes
2152
- Unclear or ambiguous phrasing
2253
- Logical issues (e.g., an entry starting with "Fixed" that actually
2354
describes a new feature, or contradictory statements)
55+
- Entries placed under the wrong section (e.g., a bug fix listed under
56+
"New features:")
2457
3. When an issue is found, use the `AskQuestion` tool to present the proposed
2558
fix to the user. Provide two options: "Accept" and "Reject".
2659
Batch related fixes into a single `AskQuestion` call when possible to
2760
reduce round-trips, but keep each fix clearly labeled.
2861
4. Apply only accepted fixes. Do not modify entries the user rejects.
2962

30-
## Phase 2: Sort Entries
63+
## Phase 2: Sort Entries into Sections
3164

32-
After grammar/logic fixes are applied, sort entries into four groups.
33-
Keep this exact order (no blank lines between groups):
65+
After grammar/logic fixes are applied, sort entries into named sections.
66+
Use these four sections in this exact order:
3467

35-
### Group 1 — New features and additions
68+
### Section 1 — `New features:`
3669

3770
Entries that semantically describe something new (e.g. `Added`), regardless of
3871
the leading verb.
3972

40-
### Group 2 — Improvements and changes
73+
### Section 2 — `Changes:`
4174

42-
Entries that describe enhancing, changing, or updating existing behavior
43-
(e.g. `Improved`, `Changed`, `Updated`), regardless of the leading verb.
75+
Entries that describe enhancing, changing, updating, removing, bumping
76+
dependencies, refactoring, or modifying existing behavior
77+
(e.g. `Improved`, `Changed`, `Updated`, `Removed`, `Bumped`, `Replaced`),
78+
regardless of the leading verb.
4479

45-
### Group 3 — Bug fixes
80+
### Section 3 — `Bugfixes:`
4681

4782
Entries that semantically describe fixing incorrect behavior (e.g. `Fixed`),
4883
regardless of the leading verb.
4984

50-
### Group 4 — Other changes
85+
### Section 4 — Other (custom name)
5186

52-
Everything else: dependency bumps, refactors, removals, tooling.
87+
If there are entries that don't fit the three sections above, use the
88+
`AskQuestion` tool to ask the user what section name to use for them, or
89+
whether to fold them into one of the existing sections.
5390

5491
### Sorting rules
5592

5693
- Use the first word after `- ` as a signal, but override when the meaning
57-
clearly fits a different group.
94+
clearly fits a different section.
5895
- Multi-line entries (parent + indented sub-bullets) stay as one unit.
59-
- Preserve original relative order within each group.
60-
- No blank lines between groups.
96+
- Preserve original relative order within each section.
97+
- Omit sections that have no entries (don't output an empty section heading).
98+
- Each section heading is followed by a blank line, then its bullet entries.
99+
- Separate sections from each other with a blank line after the last bullet.
100+
101+
## Output format
61102

62-
## Example
103+
The final output under `## Upcoming Release` must look like:
63104

64105
```markdown
106+
## Upcoming Release
107+
108+
New features:
109+
65110
- Added support for OAuth tokens
66111
- Added new `timeout` option
112+
113+
Changes:
114+
67115
- Improved error details when OAuth fails
68116
- Changed default `jsonColumnVariantParser` to `JSON.parse`
117+
- Bumped axios to 1.14.0
118+
119+
Bugfixes:
120+
69121
- Fixed a crash when loading config
70122
- Fixed typo in error message
71-
- Bumped axios to 1.14.0
72123
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "snowflake-sdk",
3-
"version": "2.3.5",
3+
"version": "2.3.6",
44
"description": "Node.js driver for Snowflake",
55
"engines": {
66
"node": ">=18"

0 commit comments

Comments
 (0)