# Update Changelog

> Update CHANGELOG.md with entries for the upcoming release before bumping the version.

- Skill: `sharex/update-changelog-2` (Agent Skill)
- Install (CLI): `npx get-skill add sharex/update-changelog-2`
- Raw SKILL.md: https://api.skillmd.com/api/skills/sharex/update-changelog-2/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: sharex (https://skillmd.com/u/sharex)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/sharex/update-changelog-2

---


# Update Changelog

## Steps

1. Open `CHANGELOG.md` in the repository root (create it if it does not exist).
2. Add a new `## [Unreleased]` section at the top (or rename an existing one to the new version).
3. Under the section, summarise all changes since the last release grouped by type:
   - `### Added` — new features
   - `### Changed` — changes to existing behaviour
   - `### Fixed` — bug fixes
   - `### Removed` — removed features
4. Stage the file: `git add CHANGELOG.md`
5. Do **not** commit yet — the release bump script will commit all staged changes together.

If there is no `CHANGELOG.md` and the user confirms it is not needed, skip this step and pass `--assume-changelog-done` to `run-release-sequence.sh`.

## Best Practices (Lessons Learnt)

When building or updating the changelog, adhere to the following key principles derived from the initial changelog extraction:

- **History Extraction**: Always run `git log` inside the inner submodule (`XerahS/ShareX.ImageEditor` or target) to acquire the true history of the component.
- **Noise Reduction & Categorization**: Review all technical, vague, and duplicate commits (such as rapid iterative UI tweaks, reverted regressions, and repeated minor fix commits). Consolidate them down into clear, public-facing feature additions, changes, bugfixes, and code refactors.
- **Format Support**: Group all completed work under the requested top-level section matching the version (e.g., `## v<VERSION>`), segmented neatly into sections like `Added`, `Changed`, `Fixed`, and `Refactored`.

