Contributing

Thanks for showing interest to contribute to MidUI ❤️, you rock!

When it comes to open source, there are different ways you can contribute, all of which are valuable. Here's a few guidelines that should help you as you prepare your contribution.

Make sure you star Midui on Github.

Add new component to the collection

To add new components you need to follow the steps

  • Open an issue on the repository with :

    • Details of component
    • Figma link to component
    • Example image
  • Once its approved by mods you can proceed with modifying the code according to CONTRIBUTING.md & opening a new pull request.

  • After approving the edits your code will be merged into the repository.

Updating the docs

To update the docs you can directly change (issue creation not required) the files in the folder (/data/docs).

Note you can not create new docs files without creating a new issue.