Contribution criteria
The contents of the Design System must be of a high quality and meet user needs. To guarantee this, all components and patterns need to meet certain criteria.
Proposing a component or pattern
To be successful, proposals need to show that the component or pattern being suggested would be useful and unique.
| Criteria | Description |
|---|---|
| Useful | There is evidence that this component or pattern would be useful for many teams or services. Evidence could be screenshots or links to versions of it being used in different services. |
| Unique | It does not replicate something already in the Design System. If it's intended to replace an existing component or pattern, there is evidence to show that it's better than the existing version. |
The Design System working group reviews proposals to check they meet these criteria. Proposals that meet the criteria then move to the next step to show they're ready to publish.
Developing a component or pattern
Before a new component or pattern is published the working group reviews the implementation to make sure it is usable, consistent and versatile.
| Criteria | Description |
|---|---|
| Usable | It has been tested in user research and shown to work with a representative sample of users, including those with disabilities. Components and patterns which are not proven usable can be published as experimental. But they must be clearly based on relevant user research from other organisations and best practice, and meet the other criteria. |
| Consistent | It reuses existing styles and components in the Design System where relevant. Both the guidance and any content included in examples must follow the gov.ie content style guide. If there is code, it follows the OGCIO-DS coding standards and is ready to merge in OGCIO-DS. |
| Versatile | The implementation is versatile enough that the component or pattern can be used in a range of different services that may need it. 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, or any other combination you may need. The component or pattern must also have been tested and shown to work with a range of browsers, assistive technologies and devices. |
Developing a community resource or tool
Before linking from the Design System to a community resource or tool the Design System team will review it to make sure that:
- it has a clear owner
- it cannot be mistaken for an official part of the Design System
- it has documentation explaining how to use it, contribute to it and get support for it
- support tickets are answered within 1 month
- it's clearly documented which version of gov.ie Frontend it supports
- it's no more than 3 months behind the latest version of gov.ie Frontend
- design resources are consistent with the styles, components and patterns in the gov.ie Design System
- development resources output the same markup as gov.ie Frontend
- it is not being charged for or used to promote a private business
- it's compatible with the Service Standard and Technology code of practice
To help users decide whether to use your resource or tool and tell them how to get support for it, add this message to the resource README and after any website links:
Need help?
If you've got a question about the gov.ie Design System, contact the team.