Skip to content

Latest commit

 

History

History
117 lines (89 loc) · 2.57 KB

CONTRIBUTING.zh-CN.md

File metadata and controls

117 lines (89 loc) · 2.57 KB

开发者贡献指南

我们非常欢迎社区的开发者向 Quark Design 做出贡献。在提交贡献之前，请花一些时间阅读以下内容，保证贡献是符合规范并且能帮助到社区。

开发配置

  • 环境要求： node ^14.17 || >= 16.0.0, yarn >=1.22

开始

第一次启动

yarn run init
yarn run dev

以后再次启动本工程只需

yarn run dev

命令说明（核心维护者发包使用）

// 发布所有子包的最后一位版本号如 0.0.1 -> 0.0.2,
yarn run release:patch

// 发布所有子包的中间一位版本号如 0.0.1 -> 0.1.0,
yarn run release:minor

// 发布所有子包的第一位版本号如 0.0.1 -> 1.0.0,
yarn run release:major

打 tag

git tag // 先看下是否生成最新的 tag
git push origin --tags

然后 github 更新 release

提交 commit

整个 Quark Design 仓库遵从 Angular Style Commit Message Conventions，在输入 commit message 的时候请务必遵从此规范。

Title Format type(ComponentName?)：commit message

分支管理：

例如：

  • docs: fix type in quickstart
  • build: optimize build speed
  • fix(Button): incorrect style
  • feat(Button): add color prop

常见问题

如何清除子项目的缓存？

yarn clean

Windows 电脑运行 yarn run link 时乱码？

// 在 git bash 中执行 yarn run link 命令

结构

├── CONTRIBUTING.MD
├── CONTRIBUTING.zh-CN.MD
├── README.MD
├── README.zh-CN.MD
├── demo.html
├── example
│   ├── babel.config.js
│   ├── dist
│   ├── global-css.js
│   ├── package.json
│   ├── scripts
│   ├── siteDist
│   ├── src
│   ├── tsconfig.json
│   ├── vite.config.ts
│   ├── yarn-error.log
│   └── yarn.lock
├── index.html
├── lerna.json lerna的核心 配置
├── LICENSE
├── package.json
├── packages 所有子包
│   ├── quark
│   ├── quark-core
│   ├── quark-react
│   ├── quark-reactify
│   ├── quark-icons
│   ├── quark-vscode-extension
│   ├── quark-rollup-plugin-postcss
│   └── quark-rollup-plugin-css-variable
├── scripts 脚本
    ├── copydocs.js
    ├── dev.js
│   ├── build.js
│   ├── link.js
│   ├── publish.js
│   └── push2io.js
└── yarn.lock