Skip to main content

GitHub Desktop でプロジェクトの変更をコミットしてレビューする

GitHub Desktopでは、ファイルを編集すると、全ての変更が追跡されます。 有意義なコミットを作成するために、変更のまとめ方を決めることができます。

コミットについて

編集されたファイルの保存と同様に、コミットは、ブランチにある1つ以上のファイルの変更を記録します。 Gitは、各コミットに次の情報を識別するSHA、またはハッシュと呼ばれる固有のIDを割り当てます。

  • 具体的な変更
  • 変更時間
  • 変更者

コミットするときは、変更を簡潔に説明するコミットメッセージを含める必要があります。 コラボレーションしているコミットに共作者を追加することもできます。

GitHub Desktopで作成したコミットがGitHub上の間違ったアカウントに関連づけられているなら、GitHub Desktopを使ってGitの設定中のメールアドレスを更新してください。 詳細については、「GitHub Desktop用のGitの設定方法」を参照してください。

リポジトリ管理者は、ブランチのルールセットを有効にして、コミット時に特定の規則を実施できます。 たとえば、ルール セットでコミットに署名を要求したり、イシュー番号をコミット メッセージの最初に参照するよう要求したりすることができます。 GitHub Desktop は警告を表示し、コミットがルールセットに従わない場合はコミットを拒否します。 詳しくは、「ルールセットについて」を参照してください。

ブランチの選択と変更の実行

  1. 新しいブランチを作成するか、ツール バーの [現在のブランチ] をクリックして一覧からブランチを選択し、既存のブランチを選択します。

    [現在のブランチ] ドロップダウン ビューのスクリーンショット。 [Recent Branches] (最近のブランチ) の下にある "my-feature" というブランチがオレンジの枠線で強調表示されています。

  2. Visual Studio Code などの好みのテキスト エディターを使って、プロジェクトのファイルに必要な変更を行います。

差分を表示する方法の選択

レビューのニーズに合わせて、GitHub Desktop に差分を表示する方法を変更できます。

差分の表示方法を変更するには、差分ビューの右上隅にある をクリックします。

  • 差分全体の表示方法を変更するには、Diff displayUnified または Split を選択します。 統合ビューでは変更が直線的に表示され、分割ビューでは左側に古い内容が表示されて、右側に新しい内容が表示されます。
  • 空白の変更を非表示にして、より実質的な変更に集中できるようにするには、 Hide Whitespace Changes を選択します。

"README" ファイルの差分ビューのスクリーンショット。 歯車アイコンがオレンジ色で囲まれています。その下の展開されたドロップダウンに [空白] と [Diff display] (差分表示) の設定が表示されています。

既定で GitHub Desktop に表示されるものより多くのファイルを表示する必要がある場合は、差分を展開できます。

  • 強調表示された変更の上または下の数行を表示するには、行番号の上または下にある矢印をクリックします。
  • ファイル全体を表示するには、差分ビューで右クリックし、 Expand Whole File をクリックします。

"README" ファイルの差分ビューのスクリーンショット。 緑色の "追加" 行のコンテキスト メニューの [Expand Whole File] (ファイル全体を展開) にカーソルが置かれています。

コミットに含める変更の選択方法

テキストエディタでファイルに変更を加えて保存していくと、変更は、GitHub Desktopにも反映されます。

左側のサイドバーにある [変更] タブで次の手順を実行します。

  • 赤い アイコンは、削除されたファイルを示します。

  • 黄色の アイコンは、変更されたファイルを示します。

  • 緑の アイコンは、追加されたファイルを示します。

  • 一時退避された変更にアクセスするには、 Stashed Changes をクリックします。

  • すべてのファイルのすべての変更を 1 回のコミットに追加するには、リストの上部にあるチェックボックスをオンにしてください。

    [変更] タブのスクリーンショット。変更されたファイルの一覧の上に "3 changed files" (3 つの変更されたファイル) というテキストがあり、その横のオンのチェックボックスがオレンジ色で囲まれています。

  • 1 つ以上のファイルのすべての変更を 1 回のコミットに追加するには、含めないファイルの隣のチェックボックスをオフにし、コミットに含めたいファイルだけを残してください。 チェックボックスは、ファイルの選択後、Spacebar または Enter キーで切り替えることができます。

部分的なコミットの作成方法

1 つのファイルに複数の変更があり、それらの変更の一部のみをコミットに含める場合は、部分的なコミットを作成できます。 追加変更やコミットできるように、他の変更はそのまま残ります。 これにより、改行の変更をコードや構文の変更から区別するなど、個別で有意義なコミットの作成が可能になります。

変更した行をコミットから除外するには、変更した行を複数クリックして、青色が消えるようにします。 青色で強調表示されている行は、コミットに含まれます。

テキスト ファイルの差分ビューのスクリーンショット。 "I don't want to include this line" (この行を含めない) というテキストの横にある行番号の背景色が青色ではなく緑色です。

変更の廃棄

保持する必要がない未コミットの変更がある場合は、変更を破棄できます。 これにより、コンピュータ上のファイルから変更が削除されます。 複数のファイル内の未コミットの変更をすべて破棄することも、追加した特定の行を破棄することもできます。

破棄した変更は、ゴミ箱内の日付つきのファイルに保存されます。 ゴミ箱を空にするまでは、破棄した変更を復元できます。

複数のファイルの変更を破棄する

  1. 変更されたファイルのリスト中で、最後のコミット以降の変更を破棄したいファイルオを選択してください。 複数のファイルを選択するには、shift をクリックして、変更を破棄したいファイルの範囲をクリックしてください。

  2. [Discard Changes] (変更の破棄) または [Discard Selected Changes] (選択された変更の破棄) をクリックして、1 つ以上のファイルに対する変更を破棄するか、 [Discard All Changes] (すべての変更を破棄) をクリックして最後のコミット以降のすべてのファイルに対する変更を破棄してください。

    [変更] タブのスクリーンショット。2 つの選択されたファイルが青色で強調表示されています。 コンテキスト メニューの [Discard 2 Selected Changes] (2 つの選択された変更を破棄する) にカーソルが置かれています。

  3. 変更を確認するには、[Confirm Discard Changes] (破棄する変更の確認) ウィンドウで影響を受けるファイルを確認し、 [変更の破棄] をクリックします。

複数の行の変更を破棄する

未コミットの変更した複数の行を破棄できます。

注: 複数の行を追加および削除する変更グループでは、単一行の破棄は無効になっています。

追加した 1 行を破棄するには、変更した行の一覧で、破棄する行の行番号を右クリックして、 [追加した 1 行の破棄] を選びます。

ファイルの差分ビューのスクリーンショット。 コンテキスト メニューで [Discard Added Line] (追加した 1 行の破棄) にカーソルが置かれ、青色で強調表示されています。

変更した行のグループを破棄するには、破棄する行の行番号の右側にある垂直のバーを右クリックして、 [追加した複数行の破棄] を選びます。

ファイルの差分ビューのスクリーンショット。 行番号の右側にある、細くて濃い青色の線がオレンジ色の枠線で強調表示されています。

コミットメッセージの入力と変更のプッシュ

コミットに含めたい変更を決めたら、コミットメッセージを入力して変更をプッシュします。 コミットで共同作業した場合、コミットに 1 人以上の作者を追加できます。

: デフォルトでは、GitHub Desktopは作成したタグを関連するコミットと共にリポジトリにプッシュします。詳細については、「GitHub Desktop でのタグの管理」を参照してください。

  1. 変更のリストの下のSummary(サマリー)フィールドに短く分かりやすいコミットメッセージを入力してください。 Description(説明)フィールドに、変更に関するさらに詳しい情報を追加することもできます。

    サイドバーの [変更] タブのスクリーンショット。 プロファイル画像の右側にある、コミット メッセージを含むテキスト フィールドがオレンジ色の枠線で囲まれています。

  2. オプションとして、コミットに別の作者を追加するには、共作者を追加するアイコンをクリックし、追加するユーザ名を入力します。

    [変更] タブのスクリーンショット。[説明] フィールドの隅にある、共同作成者を追加する "人物とプラス記号" アイコンがオレンジ色の枠線で囲まれています。

  3. [説明] フィールドの下にある [<ブランチ> にコミット] をクリックします。

  4. コミットしようとしているブランチが保護されている場合、Desktopは警告します。

    • 変更を移動するには、 switch branches をクリックします。
    • 保護されたブランチに変更をコミットするには、 [<ブランチ名> にコミット] をクリックします。

    保護されたブランチの詳細については、「保護されたブランチについて」を参照してください。

  5. ローカルの変更をリモート リポジトリにプッシュするには、リポジトリ バーの [Push origin] (オリジンへプッシュ) をクリックします。

    リポジトリ バーのスクリーンショット。 [Push origin] (オリジンへプッシュ) というボタンがオレンジ色の枠線で強調表示されています。

  6. 操作しているブランチに基づいた pull request がある場合は、GitHub Desktop のリポジトリ バーの [現在のブランチ] の横には、その pull request に対して実行されたチェックのステータスが表示されます。 チェックの詳細については、「GitHub Desktop でのチェックの表示と再実行」を参照してください。

    現在のブランチに対して pull request が作成されていない場合は、変更をプレビューして作成するオプションが GitHub Desktop に表示されます。 詳しくは、「GitHub Desktop からの issue または pull request の作成」を参照してください。

    [ローカル変更なし] ビューのスクリーンショット。 [pull request のプレビュー] というラベルのボタンがオレンジ色の枠線で強調されています。

コミット履歴の管理

コミットを元に戻す、またはコミット履歴を変更する必要がある場合 (レビュー担当者にわかりやすい変更にする場合)、GitHub Desktop には、コミット履歴を管理するための多数のオプションが用意されています。 詳しくは、「GitHub Desktop 内でコミットを管理するオプション」を参照してください。

参考資料