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 consider adding a CHANGES.md file or similar #13

Open
mlissner opened this issue Feb 22, 2023 · 0 comments
Open

Please consider adding a CHANGES.md file or similar #13

mlissner opened this issue Feb 22, 2023 · 0 comments

Comments

@mlissner
Copy link
Contributor

I'm working on some package upgrades, and I use dependabot to do them. If a project has CHANGES.md or uses the Github Releases feature, dependabot will summarize the changes made between versions. This makes upgrading a lot easier.

Beyond that, even without dependabot, having a list of changes between releases is really helpful. Since this project doesn't have that file, I had to go do a diff of the code itself to see what changed.

If it's welcome, I'd be happy to add a template CHANGES.md file to the project?

Thanks for the great package.

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