コントリビューションガイド

まず最初に、これまでのプログラムがあなたの環境でも正常に動作することを確認します。

もし、正常に動かない場合は、Issues でバグを報告して下さい。

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

コンポーネントに貢献する

Storybook を起動します。

npm run sb -w packages/react

yarn sb -w packages/react

pnpm run sb -w packages/react

npm run sb -w packages/web-components

yarn sb -w packages/web-components

pnpm run sb -w packages/web-components

そして、ブラウザでコンポーネントを確認します。

ソースコードに変更を加え、テストを行ってください。

npm run test -w packages/functions

yarn run test -w packages/functions

pnpm run test -w packages/functions

特定のテストファイルのみを実行するためには、第一引数にパスを追加します。

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

追加した機能を react, web-components で使用するためには、パッケージをビルドする必要があります。

npm run build:package -w packages/functions

yarn build:package -w packages/functions

pnpm run build:package -w packages/functions

脆弱性を報告するを参照してください。