Contribution Guide
First, make sure that the program so far works correctly in your environment. If it does not work properly, please report a bug at Issues.
- npm
- Yarn
- pnpm
npm i
npm run test
npm run build:package
yarn install
yarn run test
yarn build:package
pnpm i
pnpm run test
pnpm run build:package
Contribute Component
Launch Storybook.
- React
- npm
- Yarn
- pnpm
npm run sb -w packages/react
yarn sb -w packages/react
pnpm run sb -w packages/react
- Web Component
- npm
- Yarn
- pnpm
npm run sb -w packages/web-components
yarn sb -w packages/web-components
pnpm run sb -w packages/web-components
Then check the component in your browser.
Contribute function
Make changes to the source code and test them.
- npm
- Yarn
- pnpm
npm run test -w packages/functions
yarn run test -w packages/functions
pnpm run test -w packages/functions
To run only a specific test file, add the path as the first argument.
- npm
- Yarn
- pnpm
cd packages/functions
npm run test __tests__/any.test.ts
cd packages/functions
yarn run test __tests__/any.test.ts
cd packages/functions
pnpm run test __tests__/any.test.ts
In order to use the added functionality with react
, web-components
, you need to build the package.
- npm
- Yarn
- pnpm
npm run build:package -w packages/functions
yarn build:package -w packages/functions
pnpm run build:package -w packages/functions
Security Issues
Please see Reporting a Vulnerability