-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #381 from nhsuk/develop
Release 1.12.0
- Loading branch information
Showing
10 changed files
with
337 additions
and
225 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| {% set pageTitle = 'Contribution criteria' %} | ||
| {% set pageSection = 'Contribute' %} | ||
| {% set pageDescription = 'Follow these criteria when proposing a new component or pattern.' %} | ||
|
|
||
| {% extends 'includes/layout.njk' %} | ||
| {% from 'inset-text/macro.njk' import insetText %} | ||
|
|
||
| {% block breadcrumb %} | ||
| {{ breadcrumb({ | ||
| items: [ | ||
| { | ||
| href: "/service-manual/", | ||
| text: "Home" | ||
| } | ||
| ], | ||
| href: "/service-manual/contribute", | ||
| text: "Contribute" | ||
| }) }} | ||
| {% endblock %} | ||
|
|
||
| {% block body %} | ||
| <div class="nhsuk-grid-row"> | ||
| <div class="nhsuk-grid-column-two-thirds"> | ||
| <h1 class="nhsuk-u-margin-bottom-5">{{pageTitle}}</h1> | ||
| <p class="nhsuk-body-l nhsuk-u-margin-bottom-8">Follow these criteria when proposing a new component or pattern.</p> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="nhsuk-grid-row"> | ||
| <div class="nhsuk-grid-column-two-thirds"> | ||
|
|
||
| <p>The contents of the service manual must be of a high quality and meet user needs. To guarantee this, the service manual has a design working group to check that all components and patterns meet certain criteria.</p> | ||
|
|
||
| <h2>Criteria for proposals for new components and patterns</h2> | ||
| <p>To be successful, your proposal needs to show that the component or pattern you're suggesting will be useful and unique.</p> | ||
|
|
||
| <div class="nhsuk-table-responsive"> | ||
| <table class="nhsuk-table"> | ||
| <caption class="nhsuk-table__caption">Component proposal criteria and descriptions</caption> | ||
| <thead class="nhsuk-table__head"> | ||
| <tr class="nhsuk-table__row"> | ||
| <th class="nhsuk-table__header" scope="col">Criteria</th> | ||
| <th class="nhsuk-table__header" scope="col">Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody class="nhsuk-table__body"> | ||
| <tr class="nhsuk-table__row"> | ||
| <th class="nhsuk-table__cell">Useful</th> | ||
| <td class="nhsuk-table__cell "> | ||
| <p>You have evidence that the component or pattern would be useful for many NHS digital teams or services.</p> | ||
| <p class="nhsuk-u-margin-bottom-0">Evidence could be screenshots or links to versions in different services.</p> | ||
| </td> | ||
| </tr> | ||
| <tr class="nhsuk-table__row"> | ||
| <th class="nhsuk-table__cell">Unique</th> | ||
| <td class="nhsuk-table__cell "> | ||
| <p>We don't already have something similar in the service manual.</p> | ||
| <p class="nhsuk-u-margin-bottom-0">If you're proposing that it replace an existing component or pattern, it should be better than the existing version.</p> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| <p>The working group checks that proposals meet these criteria before they move them to the "to do" column in the community backlog.</p> | ||
|
|
||
|
|
||
| <h2>Criteria for publishing a component or pattern</h2> | ||
| <p>The working group checks that the implementation is usable, consistent and versatile.</p> | ||
|
|
||
| <div class="nhsuk-table-responsive"> | ||
| <table class="nhsuk-table"> | ||
| <caption class="nhsuk-table__caption">Component publishing criteria and descriptions</caption> | ||
| <thead class="nhsuk-table__head"> | ||
| <tr class="nhsuk-table__row"> | ||
| <th class="nhsuk-table__header" scope="col">Criteria</th> | ||
| <th class="nhsuk-table__header" scope="col">Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody class="nhsuk-table__body"> | ||
| <tr class="nhsuk-table__row"> | ||
| <th class="nhsuk-table__cell">Usable</th> | ||
| <td class="nhsuk-table__cell "> | ||
| <p>You have tested it in user research and shown that it works with a representative sample of users, including people with disabilities.</p> | ||
| <p class="nhsuk-u-margin-bottom-0">If there isn't enough research yet to show that it's usable, it can still be published as "experimental". But it must be clearly based on relevant user research from other organisations and best practice, and meet the other criteria.</p> | ||
| </td> | ||
| </tr> | ||
| <tr class="nhsuk-table__row"> | ||
| <th class="nhsuk-table__cell">Consistent</th> | ||
| <td class="nhsuk-table__cell "> | ||
| <p>It uses <a href="/service-manual/styles-components-patterns">existing styles and components</a> in the service manual where relevant.</p> | ||
| <p>The guidance and any content in examples follow the <a href="/service-manual/content">content style guide</a>.</p> | ||
| <p class="nhsuk-u-margin-bottom-0">If there is code, it follows <a href="https://github.com/nhsuk/nhsuk-frontend/blob/master/docs/contributing/coding-standards.md">the NHS.UK frontend coding standards</a> and is ready to merge into the NHS.UK frontend library.</p> | ||
| </td> | ||
| </tr> | ||
| <tr class="nhsuk-table__row"> | ||
| <th class="nhsuk-table__cell">Versatile</th> | ||
| <td class="nhsuk-table__cell "> | ||
| <p>The implementation is versatile enough to be used in a range of different services.</p> | ||
| <p>For example, a versatile date input component could be set up to ask for:</p> | ||
| <ul> | ||
| <li>a year only</li> | ||
| <li>a month and year only</li> | ||
| <li>a precise date</li> | ||
| <li>any other combination</li> | ||
| </ul> | ||
| <p class="nhsuk-u-margin-bottom-0">The component or pattern has been tested and works with a range of browsers, assistive technologies and devices.</p> | ||
| </td> | ||
| </tr> | ||
| <tr class="nhsuk-table__row"> | ||
| <th class="nhsuk-table__cell">Clinically safe</th> | ||
| <td class="nhsuk-table__cell "> | ||
| <p>You have asked for feedback from an appropriate clinician and have addressed any clinical safety issues they raised.</p> | ||
| <p class="nhsuk-u-margin-bottom-0">The working group includes a clinician trained in clinical safety. We will ask them to approve the component or pattern from a clinical safety point of view.</p> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
|
|
||
| <p>The working group uses these criteria to decide if the component or pattern is ready to publish.</p> | ||
|
|
||
| <div class="nhsuk-review-date"> | ||
| <p class="nhsuk-body-s">Updated: October 2019</p> | ||
| </div> | ||
| </div> | ||
|
|
||
| </div> | ||
| {% endblock %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,102 +1,40 @@ | ||
| {% set pageTitle = 'Contribution criteria' %} | ||
| {% set pageDescription = 'Contributions to the NHS digital service manual need to meet these criteria.' %} | ||
| {% set pageTitle = 'Contribute' %} | ||
| {% set pageDescription = 'Help to grow and improve the digital service manual.' %} | ||
|
|
||
| {% extends 'includes/layout.njk' %} | ||
| {% from 'inset-text/macro.njk' import insetText %} | ||
|
|
||
| {% block breadcrumb %} | ||
| {{ breadcrumb({ | ||
| items: [ | ||
| { | ||
| href: "/service-manual/", | ||
| text: "Home" | ||
| } | ||
| ], | ||
| href: "/service-manual/contribute", | ||
| text: "Contribute" | ||
| }) }} | ||
| {% endblock %} | ||
|
|
||
| {% block body %} | ||
| <div class="nhsuk-grid-row"> | ||
| <div class="nhsuk-grid-column-two-thirds"> | ||
| <h1 class="nhsuk-u-margin-bottom-5">{{pageTitle}}</h1> | ||
| <p class="nhsuk-body-l nhsuk-u-margin-bottom-8">Contributions to the NHS digital service manual need to meet these criteria.</p> | ||
| <p class="nhsuk-body-l nhsuk-u-margin-bottom-8">{{pageDescription}}</p> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="nhsuk-grid-row"> | ||
| <div class="nhsuk-grid-column-two-thirds"> | ||
|
|
||
| <h2>Criteria for new proposals</h2> | ||
| <p>You need to show that the new thing will be useful and unique.</p> | ||
|
|
||
| <div class="nhsuk-table-responsive nhsuk-u-margin-top-0"> | ||
| <table class="nhsuk-table"> | ||
| <caption class="nhsuk-table__caption">TBD</caption> | ||
| <thead class="nhsuk-table__head"> | ||
| <tr class="nhsuk-table__row"> | ||
| <th class="nhsuk-table__header" scope="col">Criteria</th> | ||
| <th class="nhsuk-table__header" scope="col">Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody class="nhsuk-table__body"> | ||
| <tr class="nhsuk-table__row"> | ||
| <td class="nhsuk-table__cell">Useful</td> | ||
| <td class="nhsuk-table__cell ">You have evidence that it would be useful for many NHS digital teams or services.</td> | ||
| </tr> | ||
| <tr class="nhsuk-table__row"> | ||
| <td class="nhsuk-table__cell">Unique</td> | ||
| <td class="nhsuk-table__cell ">We don't have something similar already.</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| <p>The service manual team will look at proposals in the community backlog to check that they meet these criteria before moving them to the "To do" column.</p> | ||
|
|
||
| <h2>Criteria for publishing a new thing</h2> | ||
|
|
||
| <h3>Components and patterns</h3> | ||
| <p>We need to make sure the implemention is usable, consistent and versatile.</p> | ||
| <h2>How to contribute</h2> | ||
| <p>Find out how to:</p> | ||
| <ul> | ||
| <li><a href="/service-manual/contribute/propose-new-thing">propose a new thing that's not in the backlog</a></li> | ||
| <li><a href="/service-manual/contribute/work-new-thing">work on something in the backlog</a></li> | ||
| </ul> | ||
|
|
||
| <div class="nhsuk-table-responsive nhsuk-u-margin-top-0"> | ||
| <table class="nhsuk-table"> | ||
| <caption class="nhsuk-table__caption">TBD</caption> | ||
| <thead class="nhsuk-table__head"> | ||
| <tr class="nhsuk-table__row"> | ||
| <th class="nhsuk-table__header" scope="col">Criteria</th> | ||
| <th class="nhsuk-table__header" scope="col">Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody class="nhsuk-table__body"> | ||
| <tr class="nhsuk-table__row"> | ||
| <td class="nhsuk-table__cell">Usable</td> | ||
| <td class="nhsuk-table__cell ">It has been tested in user research and shown to work with a representative sample of users, including people with disabilities.</td> | ||
| </tr> | ||
| <tr class="nhsuk-table__row"> | ||
| <td class="nhsuk-table__cell">Consistent</td> | ||
| <td class="nhsuk-table__cell ">It reuses <a href="/service-manual/styles-components-patterns">existing styles and components</a> where relevant. It follows the <a href="/service-manual/content">content style guide</a> and <a href="/service-manual/frontend-library">NHS.UK frontend library.</td> | ||
| </tr> | ||
| <tr class="nhsuk-table__row"> | ||
| <td class="nhsuk-table__cell">Versatile</td> | ||
| <td class="nhsuk-table__cell ">The implementation is versatile enough to be used in a range of different services. The component or pattern must also work with a range of browsers, assistive technologies and devices.</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| <h2>Community backlog</h2> | ||
| <p>The service manual is for everyone who makes digital products and services in the NHS. Anyone can propose, contribute, and work on new things.</p> | ||
| <div class="nhsuk-inset-text nhsuk-u-margin-top-0"> | ||
| <span class="nhsuk-u-visually-hidden">Information: </span> | ||
| <p><a href="https://github.com/nhsuk/nhsuk-service-manual-backlog">Go to the community backlog</a></p> | ||
| </div> | ||
| <p>The service manual team will use these criteria to decide if the contribution is ready to publish.</p> | ||
|
|
||
| <h3>Other things</h3> | ||
| <p>We are working on this. Please get in touch with the service manual team:</p> | ||
| <ul> | ||
| <li>Slack: <a href="https://join.slack.com/t/nhs-service-manual/shared_invite/enQtNTIyOTEyNjU3NDkyLTk4NDQ3YzkwYzk1Njk5YjAxYTI5YTVkZmUxMGQ0ZjA3NjMyM2ZkNjBlMWMxODVjZjYzNzg1ZmU4MWY1NmE2YzE">NHS.UK service manual Slack workspace</a></li> | ||
| <li>Email: <a href="mailto:service-manual@nhs.net">service-manual@nhs.net</a></li> | ||
| </ul> | ||
| <h2 class="nhsuk-u-margin-top-6">Contribution criteria</h2> | ||
| <p>To make sure everything in the service manual is of high quality, contributions need to meet the following <a href="/service-manual/contribute/contribution-criteria">contribution criteria</a>.</p> | ||
|
|
||
| <div class="nhsuk-review-date"> | ||
| <p class="nhsuk-body-s">Updated: March 2019</p> | ||
| </div> | ||
| </div> | ||
|
|
||
| </div> | ||
| {% endblock %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.