diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a3e3fadd..706bb355 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,6 +15,7 @@ e.g. This PR refactors the X submodule, applying Y's algorithm to improve Z by K - [ ] This PR has sufficient test coverage. +- [ ] I have updated the CHANGELOG.md. ## Additional Comments diff --git a/CHANGELOG.md b/CHANGELOG.md index f99e654b..721ab5ca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,10 +2,14 @@ All notable changes to this project will be documented in this file. -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). -## [Unreleased] +From v1.0.0 onwards, this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Pre-v1, breaking changes will be indicated via a minor release, while all other changes will fall under patches. At any time, you can see what's in progress for a version by filtering GitHub issues by milestone. -- [feat] support --snapshot-update cli flag to write snapshots -- [feat] support custom plugins for writing snapshots, inc. image plugin +## Master (Unreleased) + +Up to date with releases. + +## v0.1.0 + +- Initial release respecting [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).