From 6d5e6ca54778aa335c6ac2a345c0558a3ea74bf4 Mon Sep 17 00:00:00 2001 From: Jon Surrell Date: Mon, 17 Jun 2024 16:54:52 +0200 Subject: [PATCH] Update documented section headers and add "Deprecations" --- packages/README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/packages/README.md b/packages/README.md index a17b36dbc10bf9..e780d006f70fbd 100644 --- 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.