search

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
512 stars 232 forks source link

Page not found pages pattern contains typo for 'humorous' #735

Closed NickColley closed 5 years ago

NickColley commented 5 years ago

Page not found pages pattern contains typo for 'humorous'

This issue is reserved for people who are attending the Learn GitHub for content designers workshop.

Description

In the 'How it works' section of the 'Page not found pages' pattern guidance, 'humorous' is written as 'humourous' which is inconsistent with the guardian style guide (which GDS defers to)

Screenshot of issue

Screenshot of issue in the design system

Step by step

1. Claim this issue

Comment below to let other people know that you're working on this issue.

2. Edit the markdown file

You may be asked if you want to fork this repository, you can do this by selecting 'fork this repository and propose changes'.

image

You can find the markdown file for the 'Page not found pages' pattern page by going to:

https://github.com/alphagov/govuk-design-system/edit/master/src/patterns/page-not-found-pages/index.md.njk#L50

In the markdown file make the following changes:

Do not use:

 - breadcrumbs
 - technical jargon like 404 or bad request
- - informal or humourous words like oops
+ - informal or humorous words like oops
 - red text to warn people

3. Propose a change

Once you’re happy, scroll to the bottom of the page to ‘propose file change’.

Add a brief description of what you have changed in the first field. This information will be added to the file’s changelog. Try to be as clear as possible, so that future users can understand what you have done.

If you need to provide information about why you made the change, you can add more detail in the larger field below.

When you are happy with your description, select ‘propose file change’. You will have a chance to review and confirm your changes on the next page.

Screenshot of propose file change section

4. Confirm your changes

You will be shown a confirmation page where you can review the changes you’ve made. If you spot a mistake, you can go back to the previous page and correct it. If you are happy, select ‘Create pull request’. You will have one more chance to review your change on the next page before you submit it to the GOV.UK Design System team to review. Screenshot of comparison screen

5. Create a pull request

A pull request is a request sent to the team who maintains the project you’re making changes to – in this case, the GOV.UK Design System team.

It tells them what you’ve changed and gives them the option to ‘pull’ your changes into the project where it can then be published.

At this point, you can write additional comments about the work you’ve done if you want to.

These will be shared with the GOV.UK Design System team when you submit your proposed change.

It will be pre-filled with the information you entered when you proposed the file change in step 3. Please be aware that updating the information here will not change the original description you provided, but will send it in addition.

Screenshot of final confirmation screen

Once you’re happy, select ‘Create pull request’.

6. Done, wait for a review from the team

The GOV.UK Design System team will be notified of your proposal and will review it as soon as possible.

Questions

If you’ve got a question, you can comment in this issue or email the Design System team on govuk-design-system-support@digital.cabinet-office.gov.uk

gpclaridge commented 5 years ago

I am working on this issue.

NickColley commented 5 years ago

Closed by https://github.com/alphagov/govuk-design-system/pull/772 thanks @gpclaridge