Document how to update a prototype that is already on GitHub

[hannalaakso]

Related documentation

https://govuk-prototype-kit.herokuapp.com/docs/updating-the-kit

Suggestion

We should consider adding some extra instructions to the update tutorial if the prototype was already on GitHub so that other people who have a local copy of the prototype get the changed files.

Steps to add (draft)

• Branch off the main (or equivalent) branch and pull down the latest changes
  [...]
• Once the update has completed locally, commit the files and open a PR etc., depending on the process that the team working on the prototype follows

Evidence (where applicable)

A user who was updating prototypes that were already on GitHub said that it wasn't clear that after the update was complete, they needed to commit and push up the changed files.

[EoinShaughnessy]

@joelanman Should the 'Steps to add' go inside 'Updating to Version 12'? Or should they go into a new section, titled something like 'Updating a prototype that's already on GitHub'?

[lfdebrux]

@EoinShaughnessy ignore my last (now deleted comment), I had got myself confused.

I think you are right, this should go in 'Updating to Version 12', maybe with a small qualifier beforehand saying 'if you are using git/GitHub'

[EoinShaughnessy]

Thanks @lfdebrux! Would these steps go at the end of the current procedure, or somewhere inside it?

[lfdebrux]

@EoinShaughnessy at the end, they should make sure they've completed the update and everything is still working before committing and pushing changes.

[EoinShaughnessy]

@lfdebrux Thanks! I'll raise a PR shortly.

[EoinShaughnessy]

I closed the PR I'd raised, as we don't know whether this issue has affected more than one user so far. Maybe one to revisit when we have more evidence it's causing problems.

[JonJMagee]

Following review the Prototype Team are closing this ticket. If the original author wishes to raise this issue again please feel free.