コンテンツにスキップ

開発ワークフロー

本プロジェクトでは、開発環境とプロセスを先に固め、その上で機能を作る方針を取ります。 すべての機能実装 PR は以下を満たす必要があります。強制度は「ハイブリッド」 (テスト・型・ビルド・Storybook・E2E は CI で自動ゲート、ドキュメントは PR チェックリスト とレビューで担保)です。

PR に必須の 3 点セット

機能を実装する PR には、原則として次の 3 つを 同じ PR 内に 含めます。

  1. ドキュメントapps/docs への追加・更新
    • ユーザー/開発者に影響する変更は該当ガイドを更新
    • 設計判断を伴う場合は ADR を追加
  2. Storybook ストーリー — UI を追加・変更した場合
  3. E2E テスト — ユーザー操作のフローを追加・変更した場合
    • tooling/e2e に Playwright シナリオを追加

マージ前に CI が自動で確認すること(ハードゲート)

Terminal window
pnpm lint # Lint
pnpm typecheck # 型チェック
pnpm test # 単体テスト
pnpm build # 全アプリ・パッケージのビルド
# Storybook ビルド / Playwright E2E / Docs ビルド

これらが 1 つでも失敗するとマージできません(ブランチ保護 + required checks)。

コミット規約

Conventional Commits を採用します。

feat(products): 商品一覧APIを追加
fix(web): 価格表示の桁区切りを修正
docs(architecture): マルチテナント図を更新

feat / fix / docs / chore / refactor / test / ci を使用。 CI で commitlint が PR のコミットを検証します。

ローカルでの一連の流れ

Terminal window
git switch -c feat/xxx
# 実装 + ストーリー + E2E + ドキュメント
pnpm lint && pnpm typecheck && pnpm test && pnpm build
pnpm --filter @app/docs dev # ドキュメントを確認
pnpm --filter @repo/ui storybook # ストーリーを確認
pnpm --filter @repo/e2e test # E2E を確認
# PR 作成(テンプレートのチェックリストを埋める)