How to contribute - Intelligence Community Design System

Show navigation section

You can contribute more than just code! Please suggest new ideas or contribute to existing components or patterns.
You can add written guidance to the website or designs in Figma.
You should contribute in StencilJS where you can. If that is not possible there will be a delay in the contribution.
We’ve adopted the Contributor Covenant , as expanded on in our Code of Conduct . The core team, Working Group and contributors should always keep it in mind.
Read the contribution criteria .
For internal users, you can talk to us on the internal platforms, or raise an issue on GitHub for either our Design System or UI Kit .

Raise a bug or suggest improvements including brand new proposals to the UI Kit.

Raise a bug or suggest an improvement to the UI Kit through GitHub issues with as much information as possible.
Internal users can raise a bug or suggest an improvement to the UI Kit through our Service Desk.
The working group will triage your ticket and get back to you. The Working Group meet on a fortnightly basis to review new tickets, but important bugs will be reviewed sooner.

You can help us speed up the development of our Design System by contributing new components and patterns or making improvements to existing ones.

Select a ticket from the Design System or the UI Kit backlog.
If a backlog ticket doesn’t exist for your contribution, you can suggest it through GitHub Design System or UI Kit issues, or our internal Service Desk.
If you're an internal user, we will arrange a kickoff meeting to discuss the scope, plan and agree any support. For any external users, we'll work with you through GitHub issues.
Refer to the technical instructions for Design System or the UI Kit repository coding standards and practices. If you're contributing a feature, we recommend reading through the glossary of terms to help with prop/slot naming.
Create a branch offdevelop to begin. Make sure that the 'copy main branch only' setting is unchecked when forking.
Create a pull request to thedevelop branch for review.

If you're an internal user, you can contribute to the Figma UI Kit directly. If you're an external user you can raise issues and include screenshots.

Select a design ticket from the Design System or the UI Kit backlog.
If a backlog ticket doesn’t exist for your contribution, you can suggest it through GitHub Design System or UI Kit issues, or our internal Service Desk.
If you're an internal user, we will arrange a kickoff meeting to discuss the scope, plan and agree any support.
Complete the Figma contribution template and finalise the contribution.
Let us know when your contribution is ready for review.

Last reviewed 5 June 2024 .