VRUGD

Appearance

作業の進め方 ​

TIP

これはあくまで基本的な流れです。実際に作業を進める中で、
より詳細なコマンドやテクニックが必要になることもあります。
公式ドキュメントや多くのオンラインリソースを参考にしながら、理解を深めていくことをお勧めします。

INFO

ここではコマンドプロント及びTerminalでやる方法を案内しています。
GUIで操作したい場合GitHub Desktopをご利用ください。
GitHub Desktopの使い方はこちらからご確認ください。

1. リポジトリの準備 ​

  • 初めてプロジェクトに参加する場合 (クローン):

    1. GitHub上の対象リポジトリのページにアクセスします。
    2. 「Code」ボタンをクリックし、表示されるURL（HTTPSまたはSSH）をコピーします。
    3. ターミナル（またはコマンドプロンプトやGit Bashなど）を開き、作業したいディレクトリに移動します。
    4. 以下のコマンドを実行して、リモートリポジトリをローカルに複製（クローン）します。
      bash
      git clone <コピーしたリポジトリのURL>
    5. クローンしたディレクトリに移動します。
      bash
      cd <リポジトリ名>

  • 既にローカルにリポジトリがある場合 (最新化):

    1. 作業を始める前に、リモートリポジトリの最新の状態をローカルに反映させます。
      bash
      git checkout main  # または master など、主要なブランチ名
git pull origin main # リモートのmainブランチの最新情報を取得してマージ

2. 作業用ブランチの作成 ​

  • 新しい機能の開発やバグ修正は、直接main（またはmaster）ブランチで行うのではなく、専用の作業ブランチを作成して行うのが一般的です。これにより、他の開発者の作業や本番環境のコードに影響を与えることなく、安全に作業を進められます。
    bash
    git checkout -b <新しいブランチ名>
    例: feature/add-login-function や fix/issue-123 のように、目的がわかるブランチ名にします。 このコマンドは、新しいブランチを作成し、そのブランチに切り替える（チェックアウトする）操作を一度に行います。

3. 作業 (コーディング、ファイルの編集など) ​

  • 作成したブランチで、エディタやIDEを使ってファイルの追加、編集、削除などの作業を行います。

推奨IDEについて

基本的には、コマンドプロント及びTerminalでやる場合もGitHub Desktopを利用する場合も、基本的にVisual Studio Codeを推奨しています。なお、iOSなどのアプリなどの開発などで利用する場合は、各種IDEをお使いください。

4. 変更内容のステージングとコミット ​

  • 作業がある程度まとまった段階で、変更内容をGitに記録（コミット）します。
    1. 変更内容の確認:
      bash
      git status
      変更されたファイル、追加されたファイル、削除されたファイルなどが表示されます。
    2. ステージング (インデックスに追加): コミットしたい変更を選択します。
      • 特定のファイルだけをステージングする場合:
        bash
        git add <ファイル名>
      • 変更されたすべてのファイルをステージングする場合:
        bash
        git add .
    3. コミット: ステージングされた変更内容をローカルリポジトリに記録します。コミットメッセージは、どのような変更を行ったのかが簡潔にわかるように記述します。
      bash
      git commit -m "ここにコミットメッセージを記述 (例: ログイン機能の基本部分を追加)"
      良いコミットメッセージを書くことは、後から変更履歴を追跡する上で非常に重要です。

5. リモートリポジトリへのプッシュ ​

  • ローカルリポジトリで行ったコミットを、GitHub上のリモートリポジトリに反映（プッシュ）します。
    bash
    git push origin <作成したブランチ名>
    例:
    bash
    git push origin feature/add-login-function
    初めてそのブランチをプッシュする場合、上記のようにブランチ名を指定する必要があります。次回以降は git push だけで済むこともあります（設定による）。

6. プルリクエストの作成 (GitHub上での操作) ​

  • 自分の作業ブランチをmainブランチなどの主要なブランチに統合（マージ）してもらうために、GitHub上でプルリクエスト (Pull Request, PR) を作成します。
    1. GitHubのリポジトリページにアクセスします。
    2. プッシュしたブランチ名が表示されている通知（"Compare & pull request"ボタンなど）をクリックするか、リポジトリの「Pull requests」タブから「New pull request」ボタンをクリックします。
    3. baseブランチ（マージ先のブランチ、通常はmainやdevelop）とcompareブランチ（自分が作業したブランチ）を選択します。
    4. プルリクエストのタイトルと説明を記述します。どのような変更を行ったのか、レビューしてほしいポイントなどを明確に伝えます。
    5. 「Create pull request」ボタンをクリックします。

7. レビューとマージ (チーム開発の場合) ​

  • 作成されたプルリクエストは、他のチームメンバーによってレビューされます。
    • レビュー担当者はコードを確認し、コメントや修正提案を行います。
    • 必要に応じて、指摘された箇所を修正し、再度コミット＆プッシュします（プルリクエストは自動的に更新されます）。
    • レビューで問題がなければ、リポジトリの管理者や権限を持つメンバーがプルリクエストをマージします。
    • マージされると、作業ブランチの変更がmainブランチなどのターゲットブランチに統合されます。

TIP

詳しくは、プールリクエストのページで説明しています。

8. ローカルリポジトリの更新と作業ブランチの削除 ​

  • プルリクエストがマージされたら、ローカルのmainブランチも最新の状態に更新します。
    bash
    git checkout main  # mainブランチに切り替え
git pull origin main # リモートのmainブランチの最新情報を取得してマージ
  • 不要になった作業ブランチは削除できます。
    • ローカルブランチの削除:
      bash
      git branch -d <作業ブランチ名>
    • リモートブランチの削除 (GitHub上でプルリクエストがマージされると自動的に削除されるオプションもあります):
      bash
      git push origin --delete <作業ブランチ名>

作業の進め方のポイント ​

  • こまめにコミットする: 作業の区切りが良いところで、意味のある単位でコミットしましょう。
  • わかりやすいコミットメッセージを書く: 「何を変更したのか」「なぜ変更したのか」が伝わるようにしましょう。
  • 定期的にgit pullする: 特にチームで開発している場合は、他のメンバーの変更をこまめに取り込み、コンフリクト（変更の衝突）を未然に防いだり、早期に解決したりするようにしましょう。
  • コンフリクトを恐れない: コンフリクトは共同作業では起こり得るものです。落ち着いて対処方法を学びましょう。
  • ブランチ戦略を理解する: プロジェクトによっては、「Git-flow」のようなより体系的なブランチ戦略を採用している場合があります。チームのルールに従いましょう。