Skip to content

Latest commit

 

History

History
79 lines (43 loc) · 1.84 KB

CONTRIBUTING.en-US.md

File metadata and controls

79 lines (43 loc) · 1.84 KB
Raw

Contributing

English | 简体中文

We welcome your contributions. You can join us in the following ways.

Reporting Bugs

If you find a bug, please submit an issue

  • Please search for related content before submitting an issue to make sure the problem has not been mentioned.
  • Please describe the problem you encountered as detailed as possible, including operating system, browser version, and reproduction steps.
  • Please provide a minimum reproducible repository to help us locate the problem quickly.

Code Contribution

We welcome your code contribution. In order to ensure that our code structure is unified, please follow the following specifications.

Development Environment

  • Node.js >= 16.x
  • pnpm >= 7.x

Fork Repository

First, you need to Fork this repository, and then Clone your Fork repository to your local.

git clone forked-repo-url

Install Dependencies

pnpm i

Start Development Environment

pnpm site

Develop New Components

In order to ensure that everyone's code structure is consistent, if you need to create a new component, please use our command line tool to create it:

mist-cli

# Select the template to create

# Select the component

# Enter the component name, for example: tag

# Enter the style prefix, if it is consistent with the component name, press Enter directly

# Enter the site name

# Select tsx, not vue

Pull Request

  • Please make sure that the code you submit has passed the test.
  • Please submit the PR to the main branch.
  • Please write a clear and concise PR title and description.
  • Please add the corresponding issue number in the PR description, such as fix #1, close #1, resolve #1.
  • Please add the corresponding test case for the code you submit.