alphagov / govuk-design-system

One place for service teams to find styles, components and patterns for designing government services.
https://www.gov.uk/design-system
MIT License
495 stars 229 forks source link

Comms for renaming default branches #1513

Closed vanitabarrett closed 3 years ago

vanitabarrett commented 3 years ago

What

We will be doing some work to rename our default branches from master to main. We think we should communicate this change to some of our users, specifically those who make contributions.

Why

Many communities on GitHub are considering renaming the default branch name of their repository from master, as this terminology can be offensive. Statements and guidance have been published by Git here and GitHub here.

New GitHub repositories use main as the name for the default branch, so it makes sense that we should follow this convention, as well as matching what other teams within GDS are doing so we are consistent.

Additional Info

GitHub have made it easier for teams to rename branches. When we rename the branch, we get the following for "free" without having to do anything ourselves:

Who needs to know about this

Developers Content Technical Writer

Done when

vanitabarrett commented 3 years ago

I've written up the steps that I think we'll need to take to do the actual renaming for each repo; what effect this will have on our users and any actions they'll need to take. We can refer to this when deciding what on comms.

https://docs.google.com/document/d/1pPvGE90d_dyJCy4Sn2nUmxgB0Fwwii0hM0HU7OMNn9A/edit#

vanitabarrett commented 3 years ago

This is blocked until I've had a catch-up with Eoin and Calvin - I've put some time in on Tues 16th.

vanitabarrett commented 3 years ago

Had a catch-up with @EoinShaughnessy and @calvin-lau-sig7 today. Full notes here: https://docs.google.com/document/d/1pPvGE90d_dyJCy4Sn2nUmxgB0Fwwii0hM0HU7OMNn9A/edit#

We've decided to draft the following for now, and catch-up next week on how it's gone:

vanitabarrett commented 3 years ago

Have shared the draft comms with Hanna and Ollie for comments.

vanitabarrett commented 3 years ago

Moving into blocked while we wait for sign-off

vanitabarrett commented 3 years ago

Sign-off given. Have created and pinned the relevant Github issues and posted comms in our support Slack channels.