mirror of
https://github.com/element-plus/element-plus.git
synced 2024-11-21 01:02:59 +08:00
| .github | ||
| .storybook | ||
| packages | ||
| public | ||
| scripts | ||
| src/style | ||
| typings | ||
| website | ||
| .editorconfig | ||
| .eslintrc.js | ||
| .gitignore | ||
| .npmrc | ||
| CHANGELOG.en-US.md | ||
| CHANGELOG.es.md | ||
| CHANGELOG.fr-FR.md | ||
| CHANGELOG.zh-CN.md | ||
| commitlint.config.js | ||
| jest.config.js | ||
| lerna.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| yarn.lock | ||
Element-Plus
Bootstrap project
With command
$ yarn bootstrap
the project will install all dependencies and run lerna bootstrap to initialize the project
Storybook preview
With command
$ yarn storybook
the project will launch @storybook client for you to preview all existing component
Component migration process
- Convert the item in https://github.com/element-plus/element-plus/projects/1 to an issue
- Assign yourself to the issue
- Author your component by generating new component command below
- Migrate tests and docs
- Open a new pull request, fill in the component issue link in 1
Generate new component
With command
$ yarn gen component-name
Note the component-name must be in kebab-case, combining words by replacing each space with a dash.
Commit template
With command
yarn cz
Example
[TYPE](SCOPE):DESCRIPTION#[ISSUE]
# example feat(button):add type 'button' for form usage #1234