Skip to main content

Contribute to Chroma

Contributions to Chroma can come in many forms. Below are different contribution types and their associated contribution process.

Bugs or issues​

Report any bugs or issues via our Chroma Triage Form. Please provide as much detail as possible to help us replicate and investigate.

Enhancements to existing​

Chroma values feedback on how we can make our components and patterns more flexible and robust. If you have an enhancement to an existing component, pattern or documentation submit it via our Chroma Triage Form. Contributions could include things such as additional functionality, addressing a pain point or improving accessibility. Make sure to include the user need it addresses and benefit it provides along with the contribution.

New component or patterns​

Contributing to Chroma means more reusable solutions are centrally maintained and distributed, taking the weight off design and development teams across IAG. Chroma welcomes contributions of both:

  • Components: self-contained, reusable UI elements that usually have a broad application. For example, an input field.
  • Patterns: an arrangement of components and styles that usually address a specific function or purpose. For example, a postcode input.

Contribution criteria​

All contributions must met the following criteria:

  • Reusable: Serving a common interaction or need, while being reusable across multiple products and applications.
  • Brand and content agnostic: Focused on providing a specific functionality or solve a particular problem, rather than being tied to an individual brand use case or need.
  • Consistent: Built using Chroma foundations and consistent visual language to ensure brand compliance and system compatibility.
  • Re-themeable: Designed and built using colour logic to maintain accessibility and branding when switching themes.
  • Accessible: Designed and built to meet WCAG 2.1 AA accessibility standards.

How to contribute​

1. Address the contribution criteria

Confirm contributions meet the required criteria by addressing the below. Answers don’t need to be lengthy.

  • Provide the scenario/context showcasing the user need that the current components do not fulfill.
  • Highlight a few quick examples demonstrating how the component could be used in other applications or scenarios.
  • Confirm the below have been actioned/included:
    • Responsiveness addressed across different viewports.
    • Design/built using Chroma tokens (colour, border radius, typography).
    • Testing in alternative brand themes (showing simple theme switching suffices).
    • Compliance with WCAG 2.1 AA accessibility standards.
2. Supply visual resources

Component and pattern contributions come in all shapes and sizes, from wireframes to full stack solutions. Include as much design, prototyping and code resources as possible to communicate:

  • styling
  • functionality
  • user interactions
  • states
  • viewport adaptation
3. Submit

Submit step 1 and 2 via the Chroma Contribution Form.

Contributions are reviewed based on the information provided and added to the Chroma backlog. Once brought into a sprint, someone from the Chroma team will be in touch to discuss your contribution further.