From d97302f9edc015763187fa649d2cbdfe0f3cdf99 Mon Sep 17 00:00:00 2001 From: Gio Lodi Date: Mon, 17 Oct 2022 20:31:22 +1100 Subject: [PATCH 1/3] Add `CHANGELOG.md` --- CHANGELOG.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..e9b3bfad --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,35 @@ +# Changelog + +The format of this document is inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and the project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + + + +## Unreleased + + + +### Breaking Changes + +_None._ + +### New Features + +_None._ + +### Bug Fixes + +_None._ + +### Internal Changes + +_None._ From bacfb78b6bf646f8edcee13b927cf304f01664e4 Mon Sep 17 00:00:00 2001 From: Gio Lodi Date: Tue, 18 Oct 2022 20:38:30 +1100 Subject: [PATCH 2/3] Add copy-pastable template for new releases to `CHANGELOG.md` --- CHANGELOG.md | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e9b3bfad..744ae91f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,20 +4,34 @@ The format of this document is inspired by [Keep a Changelog](https://keepachang +1. Remove any empty entry (those with `_None._`) +2. Update the `## Unreleased` header to `## [](https://github.com/wordpress-mobile/WordPressKit-iOS/releases/tag/)` +3. Add a new "Unreleased" section for the next iteration, by copy/pasting the following template: ## Unreleased - +## Unreleased + ### Breaking Changes _None._ From d86706bd5a107194c32fb5f0f1e78d1d9d53bc89 Mon Sep 17 00:00:00 2001 From: Gio Lodi Date: Tue, 18 Oct 2022 22:07:05 +1100 Subject: [PATCH 3/3] Replace an "entry" with "section" in `CHANGELOG.md` Co-authored-by: Olivier Halligon --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 744ae91f..04e577fc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ The format of this document is inspired by [Keep a Changelog](https://keepachang When releasing a new version: -1. Remove any empty entry (those with `_None._`) +1. Remove any empty section (those with `_None._`) 2. Update the `## Unreleased` header to `## [](https://github.com/wordpress-mobile/WordPressKit-iOS/releases/tag/)` 3. Add a new "Unreleased" section for the next iteration, by copy/pasting the following template: