コンテンツにスキップ

01.開発フロー概要

このドキュメントでは、本プロジェクトにおける基本的な開発作業の流れ(ワークフロー)を説明します。 全ての開発作業は、このフローに沿って行われます。

開発フローの全体像

flowchart LR
    A["タスクの確認・起票<br>(Issue)"] --> B["ブランチ作成<br>(Branch)"]
    B --> C["開発・コミット<br>(Develop & Commit)"]
    C --> D["プルリクエスト作成<br>(Pull Request)"]
    D --> E["レビュー・自動チェック<br>(Review & CI)"]
    E --> F["マージ<br>(Merge)"]
    F --> G["後片付け<br>(ブランチ削除)"]

  1. タスクの確認と起票 (Issue):

    • 開発に着手する前に、対応するタスクがGitHub Issueとして起票されていることを確認します。なければ、まずIssueを作成します。
    • 詳細は 03.Issue規定 を参照してください。
  2. ブランチの作成 (Branch):

    • mainブランチから、作業内容に応じた名前のブランチを作成します。
    • 詳細は 05.ブランチ規定 を参照してください。
  3. 開発とコミット (Develop & Commit):

    • ローカル環境で開発を行い、意味のある単位でコミットします。
    • コミットメッセージの書き方については、ブランチ規定の中で定義します。
  4. プルリクエストの作成 (Pull Request):

    • 作業が完了したら、作業ブランチをGitHubにプッシュし、mainブランチへのプルリクエスト(PR)を作成します。
    • 詳細は 06.プルリクエスト規定 を参照してください。
  5. レビューと自動チェック (Review & CI):

    • PRが作成されると、GitHub Actionsによる自動チェックが実行されます。
    • 同時に、他の開発者(またはAI)によるコードレビューが行われます。
  6. マージ (Merge):

    • 全ての自動チェックが成功し、レビューで承認されたら、PRをmainブランチにマージします。
  7. 後片付け:

    • マージ後、不要になった作業ブランチを削除します。