Contribution#
Wis Design System is an open, open-source design system where anyone can contribute code, designs, and documentation.
If you are interested in participating in our development and design, we warmly welcome you and greatly appreciate your help in making Wis more outstanding and refined.
Types of Contributions#
You can choose how to contribute based on your interests and available time.
Component Enhancements#
This work involves enhancing our components in the code, such as adding new features or variants. Designers are typically responsible for user experience control and providing visual solutions, then creating design specifications for developers. You can find our design and development to-do list here.
New Components#
New components are a large, multidisciplinary contribution that must be done in stages to ensure quality and business value. When creating a new component, follow the product development lifecycle and complete all requirements in the component checklist.
All requirement categories must be completed before a component is considered finished. We recommend adding your component to Wis Labs during the discovery phase of design and code development.
Design Toolkit#
This work mainly involves creating and updating reusable design components in Figma. You will gain valuable Figma experience and collaborate with our designers. You can find issues and plans related to the Figma Kit here.
Website Documentation#
All components and patterns require usage, style, code, and accessibility guidance on the Wis website. You can learn how to smoothly contribute documentation and use our markdown templates on the documentation page.
Fixing Issues and Bugs#
If you find a bug in the source code, you can help us by filing a bug report and preferably submitting a pull request with a fix.
Process#
Whether you are contributing code, design, or documentation, a certain process must be followed. For larger contributions, such as new components or patterns, a more rigorous process must be followed to ensure production-level quality and business value. We have detailed the stages and criteria of the contribution process below.
For smaller contributions, such as minor feature additions, improvements, or bug fixes, please follow the process below.
1. Find a Suitable Project to Contribute To#
Volunteer for Existing Work#
The best way is to look through existing GitHub issues labeled with "needs: community contribution." You can also filter by code or design work. Leave a comment in the issue indicating your willingness to help.
The Wis team is also happy to help you find a good first issue. You can provide feedback at any time or contact us via Discord.
Submit New Ideas#
Do you have a new idea that you think would benefit Wis? Or do you need to report a bug? First, be sure to check the issue backlog to ensure it is a new idea or bug. Then, submit your proposal using the issue template on GitHub. If you are willing to work on this idea yourself, be sure to let us know in your issue! Your idea will then go through a triage process by the Wis team.
2. Iterate and Get Feedback#
Most contributors work in groups of 2-3 and usually schedule regular weekly meetings. During these meetings, it is common to share ongoing work and ask many questions. As you make progress, please update your GitHub issue promptly.
3. Submit for Review#
Code Deliverables#
Work involving code will be reviewed directly in a pull request (PR). Maintainers will review your work, provide feedback, ask questions, and suggest changes before merging your code. When you need to make changes, simply commit and push to your branch as usual. Once all revisions to your pull request are complete, a maintainer will squash and merge your commits for you.
Contributor License Agreement#
The Wis core team is part of Wis.Design. To accept contributions, we need you to sign a Contributor License Agreement (CLA) before code contributions can be reviewed and merged. You will be prompted to do this when submitting a pull request, but if you have any questions, please feel free to contact us.
Design Deliverables#
For work that does not involve code deliverables, such as revisions to Figma libraries, please consult the Wis team on how to complete your contribution.