-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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 new 'Unreleased' section to CHANGELOG.md. #1121
Conversation
I understand the goal of this PR but I'm afraid that add more requirements for a PR may be a burden and could make casual contributors desist. And specially for many developers which are more confident writing python than english, myself included ;-) ) I would explore the idea to auto-generate the changelog, and more generally, the whole release process. An interesting tool for this seems to be https://github.com/michaeljoseph/changes (but are dozens of similar ones, we need to research a bit) . |
All very valid points; thank you for your feedback. I have already been using an automatic changelog generator (https://github.com/github-changelog-generator/github-changelog-generator, sort-of-documented here: https://github.com/Zulko/moviepy/wiki/How-to-create-a-release). This has been fine for the past few releases that have only had bug fixes and tiny feature additions. However, now that we are doing a bit more, I think that a personalised guide to updating to v2.0 is necessary. I totally agree with your point about not wanting to make it too much of a burden for casual contributors. Either way, I'd expect to have to edit the final contents anyway, either to correct English, formatting or layout. |
that makes sense to me. |
Thanks, I'll merge this. If you've got other concerns about the template, I'm very happy to discuss them! |
With this PR, I'd like to suggest that PR owners add explanations of their PRs into the 'Unreleased' section of CHANGELOG.md. This should reduce the burden of the releaser and ensure that the changelog of a feature is created while it is still under discussion and in people's minds. Hopefully it will also increase the usefulness of the changelog which is especially important with the breaking changes that are coming up that might catch people off guard.
I've gone ahead and populated it with the changes that have been made so far.
The standard that I'm using is https://keepachangelog.com/en/1.0.0/. We could potentially also apply the categories listed there to PR labels as well?
I don't think that 'insignificant' PRs that only really affect the developers like #1118 and #1101 need to feature in the changelog.