| name | updating-changelog |
| description | Use when adding entries to any CHANGELOG.md in this repo, when the user mentions "changelog", or before/after committing user-facing changes. Enforces Keep a Changelog 1.1.0 layout, the immutability of released sections, and the migration-guide check for public-API changes. |
Updating CHANGELOG.md
Overview
This repo follows Keep a Changelog 1.1.0 and SemVer. All new entries land in an [Unreleased] section at the top of the file. Released sections are history and are never edited.
The Iron Rules
- New entries go ONLY into
[Unreleased] at the top of the file (immediately under the header preamble).
- Released version sections are immutable. Never edit, reword, reorder, or remove entries under any
## [x.y.z] - YYYY-MM-DD heading. Not for typos. Not for clarifications. The past stays the past — corrections go into the next [Unreleased] entry instead.
- Every new entry sits inside a typed subsection (
### Added, ### Changed, …). No bare bullet at the top of [Unreleased].
- Evaluate migration impact for every entry that touches a public API. If migration steps are needed, add or extend
### Migration Guide inside [Unreleased].
Allowed Subsections (Keep a Changelog 1.1.0)
Use only these, in this order, and only the ones that apply:
| Subsection | When to use |
|---|
### Added | New features, new public API, new exports |
### Changed | Changes to existing functionality (behavior, signatures, defaults, perf) |
### Deprecated | Soon-to-be-removed features still present and working |
### Removed | Features removed in this release |
### Fixed | Bug fixes |
### Security | Vulnerability fixes / security-relevant hardening |
### Migration Guide | Steps consumers must take when upgrading (see below) |
### Migration Guide is repo-specific (not in keepachangelog) and goes last inside [Unreleased].
Workflow
- Open the relevant
CHANGELOG.md. This repo currently has one: packages/twopoint5d/CHANGELOG.md. Confirm the change you are documenting belongs to that package.
- Locate
## [Unreleased]. If it does not exist, create it directly under the file's header preamble and above the most recent released version.
- Pick the subsection. Match the change to exactly one of the categories above. If the change is genuinely two things (e.g. fixed a bug and added a new method), write two entries in their respective subsections.
- Write the entry. One bullet. Concise, precise, present-tense imperative or noun phrase. Mention the affected symbol in backticks. Skip implementation chatter unless it is the point (perf entries may include the algorithmic detail).
- Migration check. Ask: "Does a consumer of
@spearwolf/twopoint5d need to change their code to upgrade past this?" If yes → add a ### Migration Guide block (see below).
- Do not touch released sections. Verify your diff only modifies the
[Unreleased] block.
Entry style
- Subject in backticks:
`ClassName#method()`, `module/file.ts`, `optionName`.
- Concise. One line preferred. Multi-line bullets only for genuinely composite changes (e.g. a perf entry that lists the techniques applied).
- Precise. State the user-visible effect, not the patch. "fix
AABB2#isInsideAABB(): corner test no longer swaps x/y" beats "tweaked logic in AABB2".
- No PR/issue links unless they add real context (e.g. an upstream three.js bug).
- No emoji, no headings inside bullets.
- Plural / multi-package commits: add one entry per affected package CHANGELOG.
Verb prefixes that match the existing style
add, fix, remove, change, simplify, refactor, perf, typecheck, upgrade. These are conventional in this repo's Unreleased entries — keep using them.
Migration Guide
Add a ### Migration Guide block inside [Unreleased] when any of these are true:
- A public export from
packages/twopoint5d/src/**/public-api.ts changed signature, semantics, or was removed/renamed.
- A default value changed in a way that alters runtime behavior.
- A peer-dep range was tightened in a way that forces consumers to upgrade.
- A previously-allowed call pattern now throws or warns.
Format:
### Migration Guide
#### `ClassName#method()` signature change
**Before**
```ts
foo.bar(opts);
After
foo.bar(opts, { strict: true });
strict defaults to false; pass true to restore the previous behavior.
One H4 (`####`) per discrete migration. Show **Before / After** code blocks. Keep it copy-pasteable.
If no migration is needed, do **not** add the section. Empty migration guides are noise.
## Canonical layout
```markdown
# CHANGELOG
All notable changes to [@spearwolf/twopoint5d](...) will be documented in this file.
The format is loosely based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- new `Foo#bar()` returning `Baz` for streaming use cases
### Changed
- `Stage2D#projection` now defaults to `Orthographic` (was `Parallax`)
### Fixed
- `Display#OnDisplayResize` no longer double-emits on the first frame
### Migration Guide
#### `Stage2D` default projection
**Before**
```ts
const stage = new Stage2D(); // → ParallaxProjection
After
const stage = new Stage2D();
const stage = new Stage2D({projection: new ParallaxProjection(...)});
[0.19.0] - 2026-02-27
- upgrade dependencies to
three@0.183.1
[0.18.5] - 2026-01-12
...
## Existing flat `[Unreleased]` entries
`packages/twopoint5d/CHANGELOG.md` currently has a flat (uncategorized) list under `[Unreleased]`. When you add new entries:
- **Add** them into proper `### <Category>` subsections at the top of `[Unreleased]`, above the existing flat bullets.
- **Do not silently rewrite** the existing flat bullets unless the user explicitly asks for a cleanup pass — those bullets are pre-existing work that the maintainer wrote in that form on purpose. If you think a cleanup pass is warranted, *propose* it before doing it.
## Common mistakes
| Mistake | Fix |
|---|---|
| Adding a bullet under a released `## [x.y.z]` heading | Move to `[Unreleased]` |
| Editing wording of a released entry to "fix a typo" | Don't. Add a `### Fixed` entry in `[Unreleased]` documenting the correction if it matters |
| Bare bullet directly under `## [Unreleased]` | Wrap in a `### <Category>` subsection |
| Putting a perf change under `### Fixed` | Use `### Changed` (perf is not a bug fix unless it fixes correctness) |
| Adding `### Migration Guide` for an internal-only change | Remove it — internal refactors don't need migration steps |
| Linking to a CHANGELOG section by line number / commit | Link by version anchor (`[0.19.0]`) or symbol name |
| One giant multi-paragraph bullet | Split into one bullet per discrete change |
| Reordering subsections | Keep the canonical order: Added → Changed → Deprecated → Removed → Fixed → Security → Migration Guide |
## Red flags — STOP
- About to edit a section under `## [x.y.z] - YYYY-MM-DD` → **stop**, the past is immutable.
- About to delete or reword an existing `[Unreleased]` bullet you didn't write this session → **ask first**.
- Tempted to add a date to `[Unreleased]` → **don't**. Releases happen via the publish pipeline, not via this skill.
- Tempted to bump a version heading or add a new `## [x.y.z]` block → **don't**. Out of scope; releases are handled separately.
