Skip to content

Latest commit

 

History

History
37 lines (21 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

37 lines (21 loc) · 1.43 KB

Contributerの方へ

ローカルでの開発方法

必要なもの

  • Node.js
  • pnpm v10以上

開発の流れ

  1. このリポジトリをクローン
  2. ルートでpnpm install
  3. pnpm run buildでビルド
  4. pnpm run storybookでStorybookで起動

変更を加え次第ビルドを行い、Storybookで確認してください。

プルリクエストの作成

基本的にはfeat/*という形式でブランチを切り、変更を加えてください。

コミットメッセージの先頭にはfeat, fix, docsなどのプレフィックスを付けてください。

プルリクエストを作成する際は、feat/*ブランチからmainブランチに向けて作成してください。

リポジトリの構成

本リポジトリではpnpm workspaceとTurporepoを使ったモノレポの構成になっています。

パッケージはコンポーネント単位で分割されており、packages/componentsにそれぞれのコンポーネントが格納されています。

changesets

リリース管理にはchangesetsを使用しています。PRを作る前にローカルでnpx changesetを実行し、変更を加えたパッケージを選択してください。

その後変更内容がmajor, minor, patchのどれに該当するかを選択し、変更内容を簡単に記述したうえでコミットしてください。