Contribute
Welcome and thank you for your interest in contributing to our beloved project.
Below you can find a handful of information and guidelines to help you jumpstart your career as a contributor to Watson.
How do I contribute
When working with Watson Design System, you have at your disposal a library of components, tokens, guidelines and recipes with examples of use.
However, it may happen that you will encounter a situation in which something is missing from our set, for such situations we have prepared a model of cooperation with product teams.
We have divided the contribution model into three categories according to their importance and complexity.
| Light contribution | A small design tweak to an existing component or style |
| Medium contribution | A bigger change to an existing component or UX pattern |
| Heavy contribution | Creating a brand-new component or UX pattern |
In a data flow chart it looks like this
Assigning the appropriate category and describing the contribution in detail will help us better understand and address the reported topic.
Would you like to contribute a new topic to us? Great, we are waiting for you! You can do this in two ways.
| 1. | Book a slot in our calendar dedicated to contributions and meet with our team to discuss the topic directly. | Book a slot |
| 2. | Send your ticket by filling out the form. Your ticket will first be discussed during the next weekly planning meeting within our team, and then we will move the communication to an open ticket. | Create a ticket |
What's next?
After receiving a contribution proposal, we will plan further cooperation steps with the submitter or their team.
The graphic below shows what the entire process may look like.
Bearing in mind that some or all of the activities may be delegated to your team, when working on the contribution, you should take into account the standards that the Watson Design System should guarantee.
Below is a list of the standards that apply.
| 1. |
Consistency in user experience (use 3 level of tokens, use right subcomponents, follow do & don’t) |
| 2. | Design principles |
| 3. | Accessibility is a must (we are following WCAG 2.1 level AA guidelines) |
In order to continue with the process of contributing, please follow these instructions under the links below,
| Design | getting-started#design |
| Development | getting-started#development |
Other ways of contribute
Find us in Slack
You can find us in the Slack channel #tech-proj-watson. This is the place where designers, engineers, and product managers are welcome. Don't hesitate to reach out to us anytime, we will be happy to support you!
Submit a ticket
If you have found a mistake in our documentation, or you are facing unexpected behavior from our Watson library, feel free to submit a ticket, and we'll be back to you as soon as possible.