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

Please maintain a basic Changelog #187

Open
risicle opened this issue Jan 9, 2019 · 0 comments
Open

Please maintain a basic Changelog #187

risicle opened this issue Jan 9, 2019 · 0 comments

Comments

@risicle
Copy link

risicle commented Jan 9, 2019

It's one thing following semantic versioning (#160) but if you don't also maintain a Changelog file you're leaving developers to go and hunt for what's actually changed every time there's a major bump, and this process risks missing something (we got burnt by the exception handling changes which weren't mentioned anywhere outside the github issues). It doesn't have to include every change made - just the breaking ones. Putting these in a single, well-known place saves developers a lot of work.

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

No branches or pull requests

1 participant