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 new 'Unreleased' section to CHANGELOG.md. #1121

Merged
merged 5 commits into from
Apr 1, 2020

Conversation

tburrows13
Copy link
Collaborator

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.

@tburrows13 tburrows13 added the project-admin Anything to do with the administration & organisation of moviepy. I.e. project "meta". label Mar 31, 2020
@tburrows13 tburrows13 requested a review from mgaitan March 31, 2020 01:15
@tburrows13 tburrows13 added this to the Release v2.0.0 milestone Mar 31, 2020
@coveralls
Copy link

coveralls commented Mar 31, 2020

Coverage Status

Coverage remained the same at 64.686% when pulling e997afa on tburrows13:new-changelog into fc691e9 on Zulko:master.

@mgaitan
Copy link
Collaborator

mgaitan commented Apr 1, 2020

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) .

@tburrows13
Copy link
Collaborator Author

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.
How about we remove the requirement for contributors to create their changelog entry, and if I decide that it could be useful, I could add it into their PR before merging? Before the final release I'll go back though the merged PRs/commits to check that nothing important has been missed.

@mgaitan
Copy link
Collaborator

mgaitan commented Apr 1, 2020

that makes sense to me.

@tburrows13
Copy link
Collaborator Author

Thanks, I'll merge this. If you've got other concerns about the template, I'm very happy to discuss them!

@tburrows13 tburrows13 merged commit 7353216 into Zulko:master Apr 1, 2020
@tburrows13 tburrows13 deleted the new-changelog branch April 26, 2020 22:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
project-admin Anything to do with the administration & organisation of moviepy. I.e. project "meta".
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants