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 PR title to PR number in Changelog #2382

Merged
merged 1 commit into from
Oct 18, 2021
Merged

Add PR title to PR number in Changelog #2382

merged 1 commit into from
Oct 18, 2021

Conversation

EoinShaughnessy
Copy link
Contributor

@EoinShaughnessy EoinShaughnessy commented Oct 14, 2021

This PR adds a previously absent PR title ('Avoid invalid nesting of <span> within a <dd> in summary list') to the Frontend Changelog.

@EoinShaughnessy EoinShaughnessy added the documentation User requests new documentation or improvements to existing documentation label Oct 14, 2021
@EoinShaughnessy EoinShaughnessy self-assigned this Oct 14, 2021
@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-2382 October 14, 2021 16:09 Inactive
@EoinShaughnessy EoinShaughnessy added this to Needs review 🔍 in Design System Sprint Board Oct 14, 2021
@36degrees
Copy link
Contributor

It also adds some standard wording ("This was added") before the fix link at the end of a release note.

I think 'this was added' makes sense when we're talking about new features, but I'm not sure it quite works for breaking changes – we've not really added anything? We're just asking the user to make a change.

CHANGELOG.md Outdated Show resolved Hide resolved
@EoinShaughnessy
Copy link
Contributor Author

@36degrees Ah gotcha - thanks. That makes sense. Will revert.

@govuk-design-system-ci govuk-design-system-ci temporarily deployed to govuk-frontend-pr-2382 October 14, 2021 16:16 Inactive
@vanitabarrett
Copy link
Contributor

@EoinShaughnessy Should we do something similar for:

This was added in pull request 1963: Remove deprecated $govuk-border-width-form-element-error variable.

It's a bit confusing to say we added a removal of something?

@EoinShaughnessy
Copy link
Contributor Author

@vanitabarrett Hmmm yeah, good point. Should we change the title of #1963 to 'Avoid deprecated $govuk-border-width-form-element-error variable'? Do we also need to say where users should avoid the variable?

@EoinShaughnessy EoinShaughnessy merged commit d6339a2 into main Oct 18, 2021
Design System Sprint Board automation moved this from Needs review 🔍 to Done 🏁 Oct 18, 2021
@EoinShaughnessy EoinShaughnessy deleted the fix-changelog branch October 18, 2021 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation User requests new documentation or improvements to existing documentation small story
Projects
Development

Successfully merging this pull request may close these issues.

None yet

6 participants