Skip to content

Add recommendation to use a changelog #221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 30, 2025
Merged

Add recommendation to use a changelog #221

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.