From 2e375cfac377ff8ecbe333205898feaf502675e4 Mon Sep 17 00:00:00 2001 From: Michael Owen Date: Mon, 5 Feb 2018 17:03:18 +0000 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 22 ++++++++-------------- 1 file changed, 8 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ea37dc2..069c76fc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,24 +1,18 @@ -# Contributing patterns and components +# Contributing to the system -If you think a pattern or component should be included in the system, first discuss it with the design community on Slack or in GitHub. +We value all contributions to the design system. -You can see our backlog of patterns and components on [GitHub](https://github.com/UKHomeOffice/home-office-digital-patterns/projects/1). To suggest a new pattern or component please [create an issue](https://github.com/UKHomeOffice/home-office-digital-patterns/issues). Add the following information to the issue: +You can discuss patterns and components that are already in the backlog or system on Slack, email, in person or on GitHub. -* the need the pattern/component meets -* why you think it should be included in the design system -* any example screenshots from other services -* any user research +You can suggest a new or missing pattern or component by [creating an issue](https://github.com/UKHomeOffice/home-office-digital-patterns/issues) in GitHub. Or by contacting our team at [design@digital.homeoffice.gov.uk](mailto:design@digital.homeoffice.gov.uk). -The Design System Working Group will move it into the backlog column and review. They may decide that another pattern meets the need better. - -## Stages - -If the Working Group agree that it is needed, it will move through the following stages: +## Stages of a new pattern/component +A Design System Working Group review new contributions. They may decide that something else meets the need better. If the Working Group agree that a pattern/component is needed, it will move through the following stages: ### Experimental -We've seen this problem in an area and it's being peer reviewed by the team and iterated upon. The pattern may change quite a lot in Experimental. Teams are free to use this pattern in their own prototypes by adding a comment to say that they will be using it. Please report back any research findings. It should not be used in production. +We've seen this problem in an area and it's being peer reviewed by the team and iterated upon. It may change a lot in Experimental. Teams are free to use it in their own prototypes. Please report back any research findings. It should not be used in production. ### Recommended -We've seen this pattern work consistently in testing and are recommending its use. **If you've found a user need** and this pattern meets it, please use this version. On occasion we may recommend a pattern or component due to the need for consistency. +We've seen this work consistently in testing and are recommending its use. If you've found a user need and this pattern or component meets it, please use this version. On occasion we may recommend a pattern or component due to the need for consistency.