Pilot a review process for the backlog

[timpaul]

Pilot a process for systematically reviewing items in the backlog and generating issues and PRs for their related component or pattern. For this process we're only focussing on things that have already been published.

[timpaul]

Here's a proposed new format for the initial comment of each backlog item (using the text input component as an example)

See next comment...

[timpaul]

Use this page to discuss the text input component in the GOV.UK Design System.

There is a separate discussion page for text input prefixes and suffixes.

This page was last reviewed on 29 September 2020.

Links

• view this component in the GOV.UK Design System
• view a list of open issues and pull requests for this component
• view the commit history of the guidance for this component
• view the commit history of the code for this component

[timpaul]

Here's a proposed checklist of actions for each backlog item:

• [ ] hide any outdated, off-topic or resolved comments
• [ ] capture significant research findings and raise PRs for the 'Research' section of the guidance
• [ ] capture significant design decisions and raise PRs for the 'How it works' section of the guidance
• [ ] capture issues, bugs and feature requests and raise issues for them in the appropriate repo
• [ ] search the repos and add the item label to any relevant issues and PRs that are missing them
• [ ] update the initial comment with links and last reviewed date
• [ ] decide whether the item should still be experimental
• [ ] set a review reminder for 6(?) months in the future

[timpaul]

QUESTIONS:

• is there value to users in providing links to open issues and PRs?
• is there value to users in providing links to the commit history of the guidance and code?
• how do we decide whether to include a research finding from the backlog in the guidance?
• how do we decide whether to include a design decision from the backlog in the guidance?
• would it be less confusing if the backlog was renamed as more of a discussion space?

[timpaul]

So far, my review of the text input backlog item has generated these issues:

• Some users think that prefixes are clickable

And these PRs:

• Explain how fixed widths are calculated
• Explain why prefixes and suffixes are outside inputs
• Add research findings from backlog

[timpaul]

Use this page to discuss the details component in the GOV.UK Design System.

This page was last reviewed on 30 September 2020.

Links

• view this component in the GOV.UK Design System
• view a list of open issues and pull requests for this component
• view the commit history of the guidance for this component
• view the commit history of the code for this component

[timpaul]

Examples of useful GitHub search patterns

Paste these into the search box on GitHub. You can also use the results page URL to bookmark or create a link to the search.

1. Open issues in our repos that have been given the "text input" label...

label:"text input" 
is:open 
repo:alphagov/govuk-design-system 
repo:alphagov/govuk-frontend 
repo:alphagov/govuk-prototype-kit

2. Open issues in our repos that contain the text "text input" but haven't been given the "text input" label...

"text input" 
-label:"text input" 
is:open 
repo:alphagov/govuk-design-system 
repo:alphagov/govuk-frontend 
repo:alphagov/govuk-prototype-kit

[kellylee-gds]

@timpaul going to close and move into done for now