Contribution

Introduction

We want to collectively deliver useful, high-quality, coherent components and guidelines, so we welcome and encourage your feedback, ideas, suggestions, and contributions - this will enable us all to create remarkable experiences for our users.

You can find all the components available on MDS on our Component Status page If you want to request a net-new component not available in our libraries or request changes to an existing component, reach out the the team on slack #rnd-designsystem.

Making a design contribuition

Design system is about collaboration and building blocks! MDS offers the elements you need to create a consistent product. If you have an idea to improve Mews surfaces by partnering with the Design System team. We would love to collaborate with you! Follow the steps below to make a design contribution:

1. Present your idea or suggestion to the team
   Set up a meeting with your discussion topic.
   Bring your work early-on— What we build into MDS comes from teams across Mews, so we’d love to provide guidance and support early and often! The earlier we see the work, the better we're able to plan, and the higher the likelihood we'll be able to help. It does not need to be a polished presentation but should have enough detail to help us understand the help you need and provide support.
2. Iterate on solutions
   We love to see more iteration in your design. We ask you to consider all edge cases before presenting your work to us and coming up with explorations and possible solutions.
3. Build or follow along
   Our team will pair directly with you, take on the work, and guide you through the whole process. If the MDS team needs to build or modify a component, we will take on the work and follow the same process. As we develop the documentation, Figma files, and code for the updated or new component, we'd love for you to help review and be part of the final check.

Pair design or consultancy

We love to contribute with product initiatives by placing a dedicated Design System designer in projects that need a design system perspective, like:

• Support to turn a team-specific component into an MDS component
• Review and document patterns, guidelines and standards design organization-wide
• Pair design from a systems perspective, such as creating a new component or reviewing design files
• Accessibility guidance

Design crits

Get in touch to request an MDS designer to join and provide insights into your projects. We're always happy to join other design teams' crits and sessions to give feedback from a design systems perspective.

Making an engineering contribuition

We always appreciate the help and contributions of other engineers across Mews, whether it's new variants, simple bug fixes, or building out entire components. Before any code changes happen though, be sure to follow these steps:

1. Talk to your designer
   Check in with your designer and make sure the changes have been approved by the MDS team, via the request process. We don’t recommend starting a PR on new functionality — no matter how small — without confirming this, as you may spend time on changes that won’t be approved to merge into MDS.
2. Technical Design Doc
   Create a technical design doc (TDD), for any net-new components or component additions/updates within MDS. This allows everyone to discuss the component API and functionality before starting to build.
3. Implement and Test
   Once the TDD has been finalized, it's time to build. If you're creating a new component, check out our documentation. Don't forget about tests if you're updating an existing component.
4. Pull request
   When your work is complete and all tests are passed, make a draft pull request for your changes by following the development guidelines. This will start the CI process, running a variety of tests. Once those tests are passed, mark your PR as "Ready for review" and ping us on #rnd-designsystem. Your changes will be reviewed by an engineer and a designer from the MDS team. We ensure each component is built to spec, accessible, performant and works well with other components.
5. Release
   Now the fun part: releasing your component! After an MDS team member merges your change and Github has been updated, feel free to announce your component/changes on the #rnd-designsystem Slack channel.

More details about how to ensure quality in our Engineering Checklist

Other ways to contribute

Bugs

If you think you’ve found a bug with MDS components or documentation, first check our MDS Bug Board to see if it’s already been reported. If it hasn’t, please file a bug ticket within the Bug Jira project and set the Component to ”MDS”. We do not actively monitor GitHub issues, so please file it in Jira.