Changelogs: Standardize sections (#58268)

Improve existing changelog entries to adhere to a more standard format. Section headers are now standardizes as: - Breaking Changes - Bug Fixes - Deprecations - Enhancements - New Features - Code Quality -> Internal - Improvements -> Enhancements - New API -> New Features - Polish -> Internal - Refactor -> Internal - Requirements -> Breaking Change - Backward Compatibility -> Bug Fixes Several header levels that were incorrect have also been corrected. The root changelog.txt and the changelog script standardize on "first-time contributors" (hyphenated) instead of "first time contributors." --- Co-authored-by: sirreal <[email protected]> Co-authored-by: t-hamano <[email protected]> Co-authored-by: gziolo <[email protected]>
WordPress · Jun 18, 2024 · 703dc20 · 703dc20
1 parent 08b77b3
commit 703dc20
Show file tree

Hide file tree

Showing 92 changed files with 1,322 additions and 1,077 deletions.
diff --git a/bin/plugin/commands/changelog.js b/bin/plugin/commands/changelog.js
@@ -961,9 +961,9 @@ function getContributorProps( pullRequests ) {
 	}
 
 	return (
-		'## First time contributors' +
+		'## First-time contributors' +
 		'\n\n' +
-		'The following PRs were merged by first time contributors:' +
+		'The following PRs were merged by first-time contributors:' +
 		'\n\n' +
 		contributorsList
 	);

diff --git a/bin/plugin/commands/common.js b/bin/plugin/commands/common.js
@@ -46,7 +46,7 @@ function calculateVersionBumpFromChangelog(
 	let changesDetected = false;
 	let versionBump = null;
 	for ( const line of lines ) {
-		const lineNormalized = line.toLowerCase().trimLeft();
+		const lineNormalized = line.toLowerCase().trimStart();
 		// Detect unpublished changes first.
 		if ( lineNormalized.startsWith( '## unreleased' ) ) {
 			changesDetected = true;

diff --git a/bin/plugin/commands/test/__snapshots__/changelog.js.snap b/bin/plugin/commands/test/__snapshots__/changelog.js.snap
@@ -284,9 +284,9 @@ The following contributors merged PRs in this release:
 `;
 
 exports[`getContributorProps verify that the contributors props are properly formatted 1`] = `
-"## First time contributors
+"## First-time contributors
 
-The following PRs were merged by first time contributors:
+The following PRs were merged by first-time contributors:
 
 - @leemyongpakvn: Fix a broken MD link in callout. ([54772](https://github.com/WordPress/gutenberg/pull/54772))
 "

diff --git a/changelog.txt b/changelog.txt
diff --git a/packages/README.md b/packages/README.md
@@ -170,10 +170,11 @@ _Example:_
 
 There are a number of common release subsections you can follow. Each is intended to align to a specific meaning in the context of the [Semantic Versioning (`semver`) specification](https://semver.org/) the project adheres to. It is important that you describe your changes accurately, since this is used in the packages release process to help determine the version of the next release.
 
--   "Breaking Change" - A backwards-incompatible change which requires specific attention of the impacted developers to reconcile (requires a major version bump).
--   "New Feature" - The addition of a new backwards-compatible function or feature to the existing public API (requires a minor version bump).
--   "Enhancement" - Backwards-compatible improvements to existing functionality (requires a minor version bump).
--   "Bug Fix" - Resolutions to existing buggy behavior (requires a patch version bump).
+-   "Breaking Changes" - A backwards-incompatible change which requires specific attention of the impacted developers to reconcile (requires a major version bump).
+-   "New Features" - The addition of a new backwards-compatible function or feature to the existing public API (requires a minor version bump).
+-   "Enhancements" - Backwards-compatible improvements to existing functionality (requires a minor version bump).
+-   "Deprecations" - Deprecation notices. These do not impact the public interface or behavior of the module (requires a minor version bump).
+-   "Bug Fixes" - Resolutions to existing buggy behavior (requires a patch version bump).
 -   "Internal" - Changes which do not have an impact on the public interface or behavior of the module (requires a patch version bump).
 
 While other section naming can be used when appropriate, it's important that are expressed clearly to avoid confusion for both the packages releaser and third-party consumers.

diff --git a/packages/a11y/CHANGELOG.md b/packages/a11y/CHANGELOG.md
@@ -137,22 +137,22 @@
 
 ## 2.9.0 (2020-04-15)
 
-### New feature
+### New Features
 
 -   Include TypeScript type declarations ([#18942](https://github.com/WordPress/gutenberg/pull/18942))
 
 ## 2.0.0 (2018-09-05)
 
-### Breaking Change
+### Breaking Changes
 
 -   Change how required built-ins are polyfilled with Babel 7 ([#9171](https://github.com/WordPress/gutenberg/pull/9171)). If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using [core-js](https://github.com/zloirock/core-js) or [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods.
 
 ## 1.1.0 (2018-07-12)
 
-### New feature
+### New Features
 
 -   Updated build to work with Babel 7 ([#7832](https://github.com/WordPress/gutenberg/pull/7832))
 
-### Polish
+### Internal
 
 -   Moved `@WordPress/packages` repository to `@WordPress/gutenberg` ([#7805](https://github.com/WordPress/gutenberg/pull/7805))
diff --git a/packages/annotations/CHANGELOG.md b/packages/annotations/CHANGELOG.md
@@ -137,7 +137,7 @@
 
 ## 1.24.0 (2020-12-17)
 
-### New Feature
+### New Features
 
 -   Added a store definition `store` for the annotations namespace to use with `@wordpress/data` API ([#26655](https://github.com/WordPress/gutenberg/pull/26655)).
 

diff --git a/packages/api-fetch/CHANGELOG.md b/packages/api-fetch/CHANGELOG.md
@@ -122,7 +122,7 @@
 
 ## 6.0.0 (2022-01-27)
 
-### Breaking changes
+### Breaking Changes
 
 `OPTIONS` requests handled by the preloading middleware are now resolved as `window.Response` objects if you explicitly set `parse: false` (for consistency with how GET requests are resolved). They used to be resolved as `Plain Old JavaScript Objects`.
 
@@ -134,7 +134,7 @@
 
 ## 5.2.0 (2021-07-21)
 
-### New feature
+### New Features
 
 -   `AbortError` being thrown by the default fetch handler can now be caught and handled separately in user-land. Add documentation about aborting a request ([#32530](https://github.com/WordPress/gutenberg/pull/32530)).
 
@@ -161,7 +161,7 @@
 
 ## 3.23.0 (2021-04-06)
 
-### New Feature
+### New Features
 
 -   Publish TypeScript definitions.
 
@@ -184,7 +184,7 @@
 
 -   A created nonce middleware will no longer automatically listen for `heartbeat.tick` actions. Assign to the new `nonce` middleware property instead.
 
-### New Feature
+### New Features
 
 -   The function returned by `createNonceMiddleware` includes an assignable `nonce` property corresponding to the active nonce to be used.
 -   Default fetch handler can be overridden with a custom fetch handler
@@ -203,18 +203,18 @@
 
 ## 2.2.0 (2018-10-29)
 
-### New Feature
+### New Features
 
 -   Always request data in the user's locale ([#10862](https://github.com/WordPress/gutenberg/pull/10862)).
 
 ## 2.1.0 (2018-10-22)
 
-### New Feature
+### New Features
 
 -   Support `per_page=-1` paginated requests.
 
 ## 2.0.0 (2018-09-05)
 
-### Breaking Change
+### Breaking Changes
 
 -   Change how required built-ins are polyfilled with Babel 7 ([#9171](https://github.com/WordPress/gutenberg/pull/9171)). If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using [core-js](https://github.com/zloirock/core-js) or [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods.
diff --git a/packages/autop/CHANGELOG.md b/packages/autop/CHANGELOG.md
@@ -141,31 +141,31 @@
 
 ## 2.7.0 (2020-04-15)
 
-### New feature
+### New Features
 
 -   Include TypeScript type declarations ([#20669](https://github.com/WordPress/gutenberg/pull/20669))
 
 ## 2.3.0 (2019-05-21)
 
-### Bug Fix
+### Bug Fixes
 
 -   `removep` will correctly preserve multi-line paragraph tags where attributes are present.
 
 ## 2.1.0 (2019-03-06)
 
-### Bug Fix
+### Bug Fixes
 
 -   `autop` correctly matches whitespace preceding and following block-level elements.
 
 ## 2.0.0 (2018-09-05)
 
-### Breaking Change
+### Breaking Changes
 
 -   Change how required built-ins are polyfilled with Babel 7 ([#9171](https://github.com/WordPress/gutenberg/pull/9171)). If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using [core-js](https://github.com/zloirock/core-js) or [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods.
 
 ## 1.1.0 (2018-07-12)
 
-### New Feature
+### New Features
 
 -   Updated build to work with Babel 7 ([#7832](https://github.com/WordPress/gutenberg/pull/7832))
 
@@ -175,6 +175,6 @@
 
 ## 1.0.6 (2018-05-08)
 
-### Polish
+### Internal
 
 -   Documentation: Fix API method typo for `removep`. ([#120](https://github.com/WordPress/packages/pull/120))
diff --git a/packages/babel-plugin-import-jsx-pragma/CHANGELOG.md b/packages/babel-plugin-import-jsx-pragma/CHANGELOG.md
@@ -94,7 +94,7 @@
 
 ## 4.0.0 (2022-08-24)
 
-### Breaking Change
+### Breaking Changes
 
 -   Increase the minimum Node.js version to 14 ([#43141](https://github.com/WordPress/gutenberg/pull/43141)).
 
@@ -106,22 +106,22 @@
 
 ## 2.2.0 (2019-05-21)
 
-### New Feature
+### New Features
 
 -   Add Fragment import handling ([#15120](https://github.com/WordPress/gutenberg/pull/15120)).
 
 ## 2.0.0 (2019-03-06)
 
-### Breaking Change
+### Breaking Changes
 
 -   Stop using Babel transpilation internally and set node 8 as a minimal version required ([#13540](https://github.com/WordPress/gutenberg/pull/13540)).
 
-### Enhancement
+### Enhancements
 
 -   Plugin skips now adding import JSX pragma when the scope variable is defined for all JSX elements ([#13809](https://github.com/WordPress/gutenberg/pull/13809)).
 
 ## 1.1.0 (2018-09-05)
 
-### New Feature
+### New Features
 
 -   Plugin updated to work with the stable version of Babel 7 ([#9171](https://github.com/WordPress/gutenberg/pull/9171)).
diff --git a/packages/babel-plugin-makepot/CHANGELOG.md b/packages/babel-plugin-makepot/CHANGELOG.md
@@ -98,13 +98,13 @@
 
 ## 5.1.0 (2022-09-13)
 
-### Bug Fix
+### Bug Fixes
 
 -   Makepot: Fix translations object handling ([#43797](https://github.com/WordPress/gutenberg/pull/43797)).
 
 ## 5.0.0 (2022-08-24)
 
-### Breaking Change
+### Breaking Changes
 
 -   Increase the minimum Node.js version to 14 ([#43141](https://github.com/WordPress/gutenberg/pull/43141)).
 
@@ -116,20 +116,20 @@
 
 ## 2.2.0 (2019-03-06)
 
-### Bug Fix
+### Bug Fixes
 
 -   Fixed Babel plugin for POT file generation to properly handle plural numbers specified in the passed header. ([#13577](https://github.com/WordPress/gutenberg/pull/13577))
 -   Fix extracted translator comments to be written as prefixed by `#.` ([#9440](https://github.com/WordPress/gutenberg/pull/9440))
 
 ## 2.1.0 (2018-09-05)
 
-### New Feature
+### New Features
 
 -   Plugin updated to work with the stable version of Babel 7 ([#9171](https://github.com/WordPress/gutenberg/pull/9171)).
 
 ## 2.0.0 (2018-07-12)
 
-### Breaking Change
+### Breaking Changes
 
 -   Updated code to work with Babel 7 ([#7832](https://github.com/WordPress/gutenberg/pull/7832))
 
@@ -139,6 +139,6 @@
 
 ## 1.0.1 (2018-05-18)
 
-### Polish
+### Internal
 
 -   Fix: Standardized `package.json` format ([#119](https://github.com/WordPress/packages/pull/119))
diff --git a/packages/babel-preset-default/CHANGELOG.md b/packages/babel-preset-default/CHANGELOG.md
@@ -49,7 +49,7 @@
 
 -   The bundled `browserslist` dependency has been updated from requiring `^4.21.9` to requiring `^4.21.10` ([#54657](https://github.com/WordPress/gutenberg/pull/54657)).
 
-## Enhancements
+### Enhancements
 
 -   Use `react` as the default scope variable for JSX pragma instead of `@wordpress/element`.
 
@@ -69,7 +69,7 @@
 
 ## 7.19.0 (2023-06-07)
 
-### Enhancement
+### Enhancements
 
 -   Enable the `bugfixes` option in `@babel/preset-env` to remove unneeded transpilation ([#50994](https://github.com/WordPress/gutenberg/pull/50994)).
 
@@ -83,7 +83,7 @@
 
 ## 7.14.0 (2023-03-29)
 
-### Enhancement
+### Enhancements
 
 -   Exclude IE-only `setImmediate`/`clearImmediate` from list of polyfills.
 
@@ -113,7 +113,7 @@
 
 ## 7.0.0 (2022-08-24)
 
-### Breaking Change
+### Breaking Changes
 
 -   Increase the minimum Node.js version to 14 ([#43141](https://github.com/WordPress/gutenberg/pull/43141)).
 
@@ -132,7 +132,7 @@
 
 ## 6.2.0 (2021-05-31)
 
-### New Feature
+### New Features
 
 -   New `build/polyfill.js` (minified version – `build/polyfill.min.js`) file is available that polyfills ECMAScript features missing in the [browsers supported](https://make.wordpress.org/core/handbook/best-practices/browser-support/) by the WordPress project. It's a drop-in replacement for the deprecated `@babel/polyfill` package ([#31279](https://github.com/WordPress/gutenberg/pull/31279)).
 
@@ -195,7 +195,7 @@
 
 ## 4.10.0 (2020-02-04)
 
-### New Feature
+### New Features
 
 -   The bundled `@babel/core` dependency has been updated from requiring `^7.4.4` to requiring `^7.8.3`. All other Babel plugins were updated to the latest version. `@babel/preset-env` has now ESMAScript 2020 support enabled by default (see [Highlights](https://babeljs.io/blog/2020/01/11/7.8.0#highlights)).
 
@@ -226,25 +226,25 @@
 -   Removed `babel-core` dependency acting as Babel 7 bridge ([#13922](https://github.com/WordPress/gutenberg/pull/13922). Ensure all references to `babel-core` are replaced with `@babel/core` .
 -   Preset updated to include `@wordpress/babel-plugin-import-jsx-pragma` plugin integration ([#13540](https://github.com/WordPress/gutenberg/pull/13540)). It should no longer be explicitly included in your Babel config.
 
-### Bug Fix
+### Bug Fixes
 
 -   The runtime transform no longer disables [the `regenerator` option](https://babeljs.io/docs/en/babel-plugin-transform-runtime#regenerator). This should resolve issues where a file generated using the preset would assume the presence of a `regeneratorRuntime` object in the global scope. While this is not considered a breaking change, you may be mindful to consider that with transformed output now explicitly importing the runtime regenerator, bundle sizes may increase if you do not otherwise mitigate the additional import by either (a) overriding the option in your own Babel configuration extensions or (b) redefining the resolved value of `@babel/runtime/regenerator` using a feature like [Webpack's `externals` option](https://webpack.js.org/configuration/externals/).
 
 ## 3.0.0 (2018-09-30)
 
-### Breaking Change
+### Breaking Changes
 
 -   The configured `@babel/preset-env` preset will no longer pass `useBuiltIns: 'usage'` as an option. It is therefore expected that a polyfill serve in its place, if necessary.
 
 ## 2.1.0 (2018-09-05)
 
-### New Feature
+### New Features
 
 -   Plugin updated to work with the stable version of Babel 7 ([#9171](https://github.com/WordPress/gutenberg/pull/9171)).
 
 ## 2.0.0 (2018-07-12)
 
-### Breaking Change
+### Breaking Changes
 
 -   Updated code to work with Babel 7 ([#7832](https://github.com/WordPress/gutenberg/pull/7832))
 
@@ -254,12 +254,12 @@
 
 ## 1.3.0 (2018-05-22)
 
-### New Feature
+### New Features
 
 -   Added support for async generator functions ([#126](https://github.com/WordPress/packages/pull/126))
 
 ## 1.2.1 (2018-05-18)
 
-### Polish
+### Internal
 
 -   Fix: Standardized `package.json` format ([#119](https://github.com/WordPress/packages/pull/119))
diff --git a/packages/base-styles/CHANGELOG.md b/packages/base-styles/CHANGELOG.md
@@ -98,7 +98,7 @@
 
 ## 4.0.0 (2021-09-09)
 
-### Breaking Change
+### Breaking Changes
 
 -   Remove the background-colors, foreground-colors, and gradient-colors mixins.
 
@@ -111,6 +111,6 @@
 
 ## 1.2.0 (2020-01-13)
 
-### Bug Fix
+### Bug Fixes
 
 -   Import `colors` into `variables` since the latter depends on the former.