Summary list component page has incorrect grammar

[NickColley]

Summary list component page has incorrect grammar

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

Description

In the 'When to use this component' section of the summary list component page, there is a grammar mistake where a sentence begins with 'Or' and should be a continuation of the previous sentence.

Screenshot of issue

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'll need select 'fork this repository and propose changes'.

You can find the markdown file for this change by going to:

https://github.com/alphagov/govuk-design-system/edit/master/src/components/summary-list/index.md.njk#L20

In the markdown file make the following changes:

## When to use this component

Use the summary list component to present pairs of related information, known as key-value pairs, in a list. The key is a description or label of a piece of information, like ‘Name’, and the value is the piece of information itself, like ‘John Smith’.

- You can use it to display metadata like ‘Last updated’ with a date like ‘22 June 2018’. Or to summarise a user’s responses at the end of a form like the [check answers](/patterns/check-answers) pattern.
+ You can use it to display metadata like ‘Last updated’ with a date like ‘22 June 2018’, or to summarise a user’s responses at the end of a form like the [check answers](/patterns/check-answers) pattern.

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.

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.

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.

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

[mattclear]

I'm working on this issue

[NickColley]

Closed thanks https://github.com/alphagov/govuk-design-system/pull/773/files