diff --git a/CHANGELOG.md b/CHANGELOG.md index f737a24d8..5df315f3b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,16 @@ # NHS digital service manual Changelog +## 1.12.0 - 21 October 2019 + +:new: **New content** + +- Add contribution criteria for community contribution + +:wrench: **Fixes** + +- Update the guidance around usage of Do & Don't lists on their own +- Update package dependencies to latest versions + ## 1.11.0 - 2 October 2019 :new: **New content** diff --git a/app/styles/main.scss b/app/styles/main.scss index f57b3b032..84d39f36a 100755 --- a/app/styles/main.scss +++ b/app/styles/main.scss @@ -141,3 +141,14 @@ h1 + .nhsuk-lede-text--small { } } } + +// Table bug hot fix +.nhsuk-table__cell.nhsuk-body-s { + display: table-cell; +} + +th, +td { + padding-left: 0; + vertical-align: top; +} diff --git a/app/views/contribute.njk b/app/views/contribute.njk deleted file mode 100644 index a124ca589..000000000 --- a/app/views/contribute.njk +++ /dev/null @@ -1,40 +0,0 @@ -{% 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 body %} -
-
-

{{pageTitle}}

-

{{pageDescription}}

-
-
- -
-
- -

How to contribute

-

Find out how to:

- - -

Community backlog

-

The service manual is for everyone who makes digital products and services in the NHS. Anyone can propose, contribute, and work on new things.

-
- Information: -

Go to the community backlog

-
- -

Contribution criteria

-

To make sure everything in the service manual is of high quality, contributions need to meet the following contribution criteria.

- -
-

Updated: March 2019

-
-
-
-{% endblock %} diff --git a/app/views/contribute/contribution-criteria.njk b/app/views/contribute/contribution-criteria.njk new file mode 100644 index 000000000..7de2212ec --- /dev/null +++ b/app/views/contribute/contribution-criteria.njk @@ -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 %} +
+
+

{{pageTitle}}

+

Follow these criteria when proposing a new component or pattern.

+
+
+ +
+
+ +

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.

+ +

Criteria for proposals for new components and patterns

+

To be successful, your proposal needs to show that the component or pattern you're suggesting will be useful and unique.

+ +
+ + + + + + + + + + + + + + + + + + +
Component proposal criteria and descriptions
CriteriaDescription
Useful +

You have evidence that the component or pattern would be useful for many NHS digital teams or services.

+

Evidence could be screenshots or links to versions in different services.

+
Unique +

We don't already have something similar in the service manual.

+

If you're proposing that it replace an existing component or pattern, it should be better than the existing version.

+
+
+

The working group checks that proposals meet these criteria before they move them to the "to do" column in the community backlog.

+ + +

Criteria for publishing a component or pattern

+

The working group checks that the implementation is usable, consistent and versatile.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Component publishing criteria and descriptions
CriteriaDescription
Usable +

You have tested it in user research and shown that it works with a representative sample of users, including people with disabilities.

+

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.

+
Consistent +

It uses existing styles and components in the service manual where relevant.

+

The guidance and any content in examples follow the content style guide.

+

If there is code, it follows the NHS.UK frontend coding standards and is ready to merge into the NHS.UK frontend library.

+
Versatile +

The implementation is versatile enough to be used in a range of different services.

+

For example, a versatile date input component could be set up to ask for:

+
    +
  • a year only
    • +
  • a month and year only
    • +
  • a precise date
    • +
  • any other combination
    • +
+

The component or pattern has been tested and works with a range of browsers, assistive technologies and devices.

+
Clinically safe +

You have asked for feedback from an appropriate clinician and have addressed any clinical safety issues they raised.

+

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.

+
+
+ +

The working group uses these criteria to decide if the component or pattern is ready to publish.

+ +
+

Updated: October 2019

+
+
+ +
+{% endblock %} diff --git a/app/views/contribute/index.njk b/app/views/contribute/index.njk index 504c0deb0..539756c3b 100644 --- a/app/views/contribute/index.njk +++ b/app/views/contribute/index.njk @@ -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 %}

{{pageTitle}}

-

Contributions to the NHS digital service manual need to meet these criteria.

+

{{pageDescription}}

-

Criteria for new proposals

-

You need to show that the new thing will be useful and unique.

- -
- - - - - - - - - - - - - - - - - - -
TBD
CriteriaDescription
UsefulYou have evidence that it would be useful for many NHS digital teams or services.
UniqueWe don't have something similar already.
-
-

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.

- -

Criteria for publishing a new thing

- -

Components and patterns

-

We need to make sure the implemention is usable, consistent and versatile.

+

How to contribute

+

Find out how to:

+ -
- - - - - - - - - - - - - - - - - - - - - - -
TBD
CriteriaDescription
UsableIt has been tested in user research and shown to work with a representative sample of users, including people with disabilities.
ConsistentIt reuses existing styles and components where relevant. It follows the content style guide and NHS.UK frontend library.
VersatileThe 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.
+

Community backlog

+

The service manual is for everyone who makes digital products and services in the NHS. Anyone can propose, contribute, and work on new things.

+
+ Information: +

Go to the community backlog

-

The service manual team will use these criteria to decide if the contribution is ready to publish.

-

Other things

-

We are working on this. Please get in touch with the service manual team:

- +

Contribution criteria

+

To make sure everything in the service manual is of high quality, contributions need to meet the following contribution criteria.

Updated: March 2019

-
{% endblock %} diff --git a/app/views/contribute/propose-new-thing.njk b/app/views/contribute/propose-new-thing.njk index fbb89c4dd..88057a71d 100644 --- a/app/views/contribute/propose-new-thing.njk +++ b/app/views/contribute/propose-new-thing.njk @@ -43,7 +43,7 @@ diff --git a/app/views/contribute/work-new-thing.njk b/app/views/contribute/work-new-thing.njk index 0488ea9a5..6fbae8f2b 100644 --- a/app/views/contribute/work-new-thing.njk +++ b/app/views/contribute/work-new-thing.njk @@ -51,7 +51,7 @@

4. Send your contribution for review