unitysetup.powershell icon indicating copy to clipboard operation
unitysetup.powershell copied to clipboard

Add a CHANGELOG.md file to the repo and start tracking changes

Open FejZa opened this issue 5 years ago • 2 comments

This would help to understand what changed actually. I suggest following this guide https://keepachangelog.com/en/1.0.0/

FejZa avatar Jan 18 '19 08:01 FejZa

I dig it. The Release PRs have had some notes about all the changes, but they can be hard to find and are more focused on testing the change than communicating it.

So we could keep an Unreleased section accumulating in the 'develop' branch, and then upgrade them when moving that into 'master'.

Would we make everyone who did a PR update the changelog?

jwittner avatar Jan 29 '19 06:01 jwittner

Exactly. That's how I am managing it in my repo. Have an [Unreleased] section populate until a new release is made and then assign it the new version.

Everyone doing a PR can add his changes to the [Unreleased]. I understand this adds some additional work to manage things but once people get used to the workflow, it's easy.

FejZa avatar Jan 29 '19 08:01 FejZa