search

SuperGoodSoft / solidus_taxjar

Support for using TaxJar to handle tax calculations in Solidus
BSD 3-Clause "New" or "Revised" License
12 stars 12 forks source link

Update CHANGELOG to "Keep a Changelog" format #215

Closed forkata closed 11 months ago

forkata commented 1 year ago

What is the goal of this PR?

This updates the CHANGELOG file to use the format suggested by https://keepachangelog.com and breaks up the changes which will be included in the next release into a few separate categories. It also includes a section at the top titled Unreleased where we will add all future changes. That will hopefully help people who use the extension through Rubygems see what will be coming in the next official release.

I am hoping this format help users of the extension easily identify the changes they need to be aware of when upgrading to a new release and also provide us with a framework for how to consistently identify and group related changes.

I looked at the format solidusio/solidus uses for their CHANGELOG file, but did not find that to be as helpful as this. That file just has a big section of Major changes under each release, which doesn't really help quickly identify what you need to be aware of. I personally find breaking out the additive changes from the removals and changes in behaviour to be useful when upgrading gem versions.

I am proposing this format, but would love to hear if others have suggestions for a different one.

How do you manually test these changes? (if applicable)

N/A

Merge Checklist

Update: We are going to merge this before we've finalized the 1.0 release so this no longer applies.

forkata commented 11 months ago

@Noah-Silvera I rebased this and updated it for the changes we've merged since I opened it. I think we should merge this now so it's ready for release, we just need to change the Unreleased to 1.0 (datestamp) when we're ready to publish that release.