From e0ca933c56fa240adbe91768ae3ef26325ba7ea2 Mon Sep 17 00:00:00 2001 From: Jordan Jensen Date: Fri, 27 Jun 2025 10:30:21 -0700 Subject: [PATCH] Add recommendation to use a changelog --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2c852be4..13314b65 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -376,3 +376,11 @@ above [Removing an entire piece of content](#removing-an-entire-piece-of-content section. In addition references to the content in GitHub workflows will need to removed. + +## Using a CHANGELOG + +It is recommended to use a `CHANGELOG.md` file in your extension directory +to document changes made on each release. + +A recommended format is the [keep a changelog](https://keepachangelog.com/en/1.1.0/) +format and ahering to the [Semantic Versioning](https://semver.org/) guidelines.