Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

33 lines (21 loc) · 1.32 KB
Raw

Welcome to MUI Treasury contributing guide

Thank you for your time in contributing to MUI Treasury! Let's build a block ✨.

Types of contributions

Request a block

To request a block, open a new issue with the title Request: [block name] and describe the block you want. If you have a design inspiration, please attach it to the issue.

Add a block

  1. Pick a block you want to work on and comment on the issue that you are working on it.

Note: if there is no block that you want to work on, you can create a new issue to request a block and start working on it.

  1. Fork the mui-treasury and clone it to your local machine.

  2. Create a new branch from main branch with the name block/[block-name] (e.g. block/card-news-maldives).

  3. Run a script to create a new block, the block name should follow the format of {component}-{style}-{name} (e.g. card-news-maldives).

    yarn new-block [block-name]

  4. run yarn storybook to see the block and start working on it.

  5. create a PR.

CLI development

  • Run yarn dev to start watching the changed files.
  • Make changes to the src folder.
  • Run yarn link
  • Run mui-tresury ... to test the CLI.