コントリビューション ガイド
まず最初に、これまでのプログラムがあなたの環境でも正常に動作することを確認します。
もし、正常に動かない場合は、Issues でバグを報告して下さい。
- npm
- Yarn
- pnpm
- Bun
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
bun install
bun run test
bun run build:package
コンポーネントに貢献する
Storybook を起動します。
- npm
- Yarn
- pnpm
- Bun
npm run sb -w packages/react
yarn sb -w packages/react
pnpm run sb -w packages/react
bun run sb -w packages/react
そして、ブラウザでコンポーネントを確認します。
機能(functions)に貢献する
ソースコードに変更を加え、テストを行ってください。
- npm
- Yarn
- pnpm
- Bun
npm run test -w packages/functions
yarn run test -w packages/functions
pnpm run test -w packages/functions
bun run test -w packages/functions
特定のテストファイルのみを実行するためには、第一引数にパスを追加します。
- npm
- Yarn
- pnpm
- Bun
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
cd packages/functions
bun run test __tests__/any.test.ts
追加した機能を react で使用するためには、パッケージをビルドする必要があります。
- npm
- Yarn
- pnpm
- Bun
npm run build:package -w packages/functions
yarn build:package -w packages/functions
pnpm run build:package -w packages/functions
bun run build:package -w packages/functions
Changeset
リリースに含めたい変更をした場合は、changeset を追加します。
- npm
- Yarn
- pnpm
- Bun
npm run changeset
yarn changeset
pnpm run changeset
bun run changeset
.changeset/ 以下にマークダウンファイルが作られるので、変更と一緒にコミットしてください。
bump の種類は次のように選びます。
patch— バグ修正minor— 新機能、および破壊的変更（このプロジェクトは0.xを維持するため。majorを選ぶと1.0.0になります）major— 当面は使いません
@tremolo-ui/functions と @tremolo-ui/react は常に同じバージョンでリリースされるため、
片方だけを選んでも両方が bump されます。
リリースは自動化されています。変更が main に入ると "Version Packages" プルリクエストが
作成（または更新）され、それをマージした時点で npm への publish と CHANGELOG の生成が行われます。
セキュリティの問題
脆弱性を報告する を参照してください。