Skip to main content

Contribution Process

Step-by-step instructions how to contribute a design pattern to Modus.

The Modus Delivery Team is dedicated to maintaining a consistent, top-quality product. Accordingly, before any component is revised or added, it goes through a process of reviews and approvals.

Contribution Process

1. Understanding the design system and the process

During this stage you review our documentation, Submission Guidelines, and process. You should also familiarize yourself with our design principles and foundations, which address visual design, UX, content, branding, and accessibility (Foundations section of Modus). Soon, you will also be able to review personas and user archetypes, so you can better understand who your design should serve.

2. Submission

Identify the user needs your pattern solves and explain its advantages over alternative patterns. Include original design files and any user research that supports this pattern. You should contribute a pattern when

a.) A new component has been created on your product team (e.g. Chips for displaying and interacting with content filters).

b.) The component exists as design elements and interaction pattern sequence in Figma.

c.) The component has undergone usability testing with documented results or is currently in use in the product.

d.) The product team decides to propose the pattern to the Modus Approval Board (MoAB).

To submit your pattern, please follow the Submission Guidelines. Upon submission, GitHub issue is created on the Modus Design System backlog. The pattern (along with all the provided documentation is assigned an ID and the submitting party is added as followers of the issue, so they can track the progress.

3. Review

Once an issue is entered into the backlog the Modus Approval Board (MoAB) reviews the new pattern submission, iterates it (if needed) with the submission author, and informs the Modus Product Manager about the final result. Patterns are reviewed according to the following criteria:

a.) Pattern is designed according to the current design standards (tokens, foundations, as put forward in the style guide and existing pattern library)

b.) Pattern presents new functionality or promises to solve an existing design problem in a novel way

c.) Each individual reviewer should conduct a heuristic review of the pattern and come prepared with an assessment grade:

1 = I have some significant design and/or usability concerns (document these concerns)

2 = The pattern seems useful and generally usable, but I would request a few tweaks (document these tweaks and the reason for requesting them)

3 = The pattern seems useful and generally usable, and I have no concerns

Some of the criteria used in the heuristic review include (but are not limited to)

  • Usability
    • Is the pattern responsive?
    • Is the interaction flow and behavior clearly documented?
  • Accessibility
    • Is the pattern accessible to all audiences?
    • Does it meet WCAG 2.1 standards?
  • Visual design
    • Is the contribution consistent with our visual style?
  • Content
    • Does the pattern have plain language, correct spelling, and grammar?
    • Are actions clearly described?
    • Is there enough contextual information to aid the user?

d.) Review usability tests or any other submitted research data.

You can track the status of submissions. The status can be approved, partially approved (if iteration needed), presented for evaluation by a Tiger Team, or marked not compliant with Modus.

4. Prioritization and recommendation

When the pattern is approved, it is prioritized and scheduled for a release. The Modus Delivery Team will make sure your pattern is added to all supported code and design libraries, conduct ongoing maintenance of your pattern, and monitor its usage.