-
Notifications
You must be signed in to change notification settings - Fork 141
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
USWDS-Site: Add changelog entries for #5358 #2160
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thoughts on combining these notes into one? They both come from a single code change. Otherwise LGTM.
@mejiaj That's a good question. I could really go either way on combining them. I lean towards keeping them separate for a couple of reasons:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! I'm indecisive about splitting into two or combining into one changelog. Maybe we should establish a pattern for if each changelog item is per change or per PR.
@mahoneycm @mejiaj
I believe this was born out of some of the earlier discussions about changelogs. Happy to discuss this more if you are inclined to change the standard. We also could refine the README to be more clear if it feels muddled. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@amyleadem thanks for the feedback. Approving since there doesn't be a strong reason to combine them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I support Amy's reasoning for a per-change approach to changelogs. A single PR may have multiple changelog-worthy items.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updating the changelogs to add dummy version number
Summary
Added changelog entries for uswds/uswds#5358
Preview link
Pagination changelog