Skip to content

Framework: Update "Maintaining Changelogs" section to current recommendations - #15740

Merged
aduth merged 2 commits into
masterfrom
update/changelog-guidelines
May 22, 2019
Merged

aduth merged 2 commits into
masterfrom
update/changelog-guidelines

Conversation

@aduth

@aduth aduth commented May 20, 2019 •

Copy link
Copy Markdown
Member

Related:

This pull request seeks to update the packages document "Maintaining Changelogs" section, as the information was no longer accurate as of the revised packages release process implemented in #14136. It now describes how a developer should not choose the version, but instead add changes under a relevant subsection in a "Master" heading at the top of the file. It also includes specific mentions of the common subsections used in changelogs (breaking change, new feature, etc).

Testing Instructions:

Documentation-only changes. There is no impact on the application.

@aduth aduth added [Type] Developer Documentation Documentation for developers [Type] Project Management Meta-issues related to project management of Gutenberg labels May 20, 2019

@gziolo gziolo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, it’s all nicely explained and much better aligns with how we approach the process these days 👍

@nerrad

nerrad commented May 21, 2019

Copy link
Copy Markdown
Contributor

Love it 👍 ! I would like to see the inclusion of links to pulls for each change too.

@ntwb

ntwb commented May 21, 2019

Copy link
Copy Markdown
Member

@nerrad This can be quite time consuming and cumbersome, considering the changelog requirements are to include the proposed changelog entry in the pull request the PR number is not known at this stage, as such a follow up commit is required for each PR submitted.

@nerrad

nerrad commented May 21, 2019

Copy link
Copy Markdown
Contributor

PR number is not known at this stage, as such a follow up commit is required for each PR submitted.

Which is what I've been doing. I agree it's a bit of a chore, but the question is whether the benefits (having an easy reference to the pull implementing the change) outweigh the negatives (doing an extra commit adding the link). I can't answer that for everyone, but for me I find it super useful and the benefits outweigh the chore.

Yes I know git history can be used as well.

My suggestion is definitely not a blocker to this getting merged.

@aduth

aduth commented May 22, 2019

Copy link
Copy Markdown
Member Author

I agree with both of you. And I agree it shouldn't block. (It's an agreement party! 😄 )

At this point, I'll be happy if we can get people to add changelog notes at all, before considering how to make it more cumbersome to do so. From there I'd explore enforcement (#13594) and automation separately.

@aduth
aduth merged commit d15c484 into master May 22, 2019
@aduth
aduth deleted the update/changelog-guidelines branch May 22, 2019 20:46
@youknowriad youknowriad added this to the 5.8 (Gutenberg) milestone May 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Developer Documentation Documentation for developers [Type] Project Management Meta-issues related to project management of Gutenberg

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants