Skip to content

Conversation

tmlayton
Copy link
Contributor

There were a few PRs (#524, #691, and #698) that touched a non-trivial amount of code, were done for code quality reasons, but did not have a changelog entry. This proved problematic when understanding what level of risk, thus manual testing needed to be done before releasing.

While we can go through the history of commits, it is more efficient to tell a clear story of impact in the changelog, even if not all changes are consumer facing.

Copy link
Member

@BPScott BPScott left a comment

Choose a reason for hiding this comment

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

Nice

(Should all the groupings mentioned in the doc have a heading in unreleased.md?

Copy link
Contributor

@kaelig kaelig left a comment

Choose a reason for hiding this comment

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

I like how it celebrates refactors and other unseen improvements.

I notice we don't have a category related to performance - and that's also something I'd love to see us celebrate / encourage / incentivize… would that fall under the same category?

Copy link
Member

@kvendrik kvendrik left a comment

Choose a reason for hiding this comment

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

🎉💯

@tmlayton
Copy link
Contributor Author

Should all the groupings mentioned in the doc have a heading in unreleased.md?

Yes, I think they just got removed somewhere along the lines.

I notice we don't have a category related to performance - and that's also something I'd love to see us celebrate / encourage / incentivize… would that fall under the same category?

I’m good with adding a perf category, I think it makes sense to call out separately because it might not always make the source code "better" (easier to read, etc).

@tmlayton
Copy link
Contributor Author

Will leave the suggestions for future PRs

@tmlayton tmlayton merged commit 54bdd86 into master Dec 17, 2018
@tmlayton tmlayton deleted the housekeeping-changes branch December 17, 2018 22:27
@danrosenthal danrosenthal temporarily deployed to production January 7, 2019 14:27 Inactive
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

Successfully merging this pull request may close these issues.

6 participants