CONTRIBUTING.md

mincu 贡献指南

mincu 的项目结构为 monorepo，使用 pnpm workspaces + lerna lite 管理（之前为 yarn workspaces + lerna）。在开发之前，你需要先安装 pnpm

项目初始化

$ git clone https://github.com/ncuhome/mincu # or clone your fork
$ cd mincu
$ pnpm i
$ pnpm dev

# then start coding in packages/*

如何调试 debug, debug-tools

$ pnpm dev
$ pnpm dev:debug-tools
# then start coding in packages/debug or packages/debug-tools

运行示例

# example/vanilla-ts
$ pnpm start

其他示例见 example，也可参考 使用到的项目

添加依赖

根目录下添加：

pnpm add -DW <package-name>

某个 packages 下添加：

pnpm --filter <target-package-name> add <package-name>

发版（需要 NPM 账号权限）

更新版本号并发布到 npm

pnpm release #--dry-run