Update Changelog
Steps
- Open
CHANGELOG.mdin the repository root (create it if it does not exist). - Add a new
## [Unreleased]section at the top (or rename an existing one to the new version). - 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
- Stage the file:
git add CHANGELOG.md - 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 loginside the inner submodule (XerahS/ShareX.ImageEditoror 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 likeAdded,Changed,Fixed, andRefactored.