pro-components/CONTRIBUTING.md
kalykun 665d7c494d
docs: pnpm instead of yarn (#6625)
* docs: `pnpm` instead of `yarn`

* chore: ++
2023-02-17 14:09:50 +08:00

1.1 KiB

Contributing to pro-components

Set up

Install dev deps after git clone the repo.

$ pnpm i

run start

$ pnpm start

Build

Transform with babel and rollup.

$ pnpm build

# Build and monitor file changes
$ pnpm build --watch

# Build specified package only
$ PACKAGE=plugin-antd pnpm build --watch

Test

Run test.

$ pnpm test

# Test specified file and watch
$ pnpm test getMockData.test.js -w

# Test specified package
$ pnpm test --package core

# Generate coverage
$ pnpm test --coverage

Release

$ npm run release
$ npm run release -- --publish-only
$ npm run release -- --skip-git-status-check
$ npm run release -- --skip-build
$ npm run release -- --conventional-graduate
$ npm run release -- --conventional-graduate preset-react,plugin-dva

Create new package

Such as creating package foo.

$ mkdir -p packages/foo
$ pnpm bootstrap

Then you will find the README.md and package.json is generated in packages/foo.

$ tree packages/foo
packages/foo
├── README.md
└── package.json

change the authors in package.json