Skip to content
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.

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

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

Open
FejZa opened this issue Jan 18, 2019 · 2 comments
Open

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

FejZa opened this issue Jan 18, 2019 · 2 comments

Comments

@FejZa
Copy link

FejZa commented Jan 18, 2019

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

@jwittner
Copy link
Member

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?

@FejZa
Copy link
Author

FejZa commented Jan 29, 2019

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants