Hello World

この Hello World 演習に従い、GitHub の pull request ワークフローを学習します。

この記事の内容

はじめに

このチュートリアルでは、リポジトリ、ブランチ、コミット、pull request などの GitHub の要点について説明します。 独自の Hello World リポジトリを作成し、GitHub の pull request ワークフローについて学びます。これは、コードを作成してレビューする一般的な方法です。

このクイックスタート ガイドでは、次の操作を行います。

  • リポジトリを作成して使用する。
  • 新しいブランチの開始および管理。
  • ファイルに変更を加え、コミットとして GitHub にプッシュする。
  • pull request の開始およびマージ。

前提条件

  • GitHub アカウントを所持している必要があります。 詳しくは、「GitHub でのアカウントの作成」をご覧ください。

  • コードを作成し、コマンド ラインを使用し、Git (GitHub が構築されているバージョン コントロール ソフトウェア) をインストールする方法を知る必要はありません。

手順 1: リポジトリを作成する

まず、リポジトリを作成します。 リポジトリは、ファイル、画像、ビデオ、その他のフォルダーなど、関連する項目を含むフォルダーであると考えることができます。 リポジトリは通常、同じ "プロジェクト" に属する項目、または作業中のものをグループ化します。

多くの場合、リポジトリには README ファイル (プロジェクトに関する情報を含むファイル) が含まれます。 Markdown で書かれた README ファイルは、プレーンテキストを書式設定するための読みやすく書きやすい言語です。 Markdown の詳細については、次のチュートリアル「プロフィールの設定」を参照してください。

GitHub を使用すると、新しいリポジトリを作成するのと同時に README ファイルを追加できます。 GitHub にはライセンス ファイルなどの他の一般的なオプションも用意されていますが、現在はそれらを選択する必要はありません。

hello-world リポジトリは、アイデアやリソースを格納し、他のユーザーと共有し話し合う場所にすることができます。

  1. ページの右上隅で を選択し、 [新しいリポジトリ] をクリックします。

    新しいアイテムを作成するオプションを示す GitHub ドロップダウン メニューのスクリーンショット。 [新しいリポジトリ] というメニュー項目が濃いオレンジ色の枠線で囲まれています。

  2. [リポジトリ名] ボックスに「hello-world」と入力します。

  3. [説明] ボックスに簡単な説明を入力します。 たとえば、「このリポジトリは GitHub Flow を実行するためのリポジトリです」と入力します。

  4. リポジトリが [パブリック] か [プライベート] かを選択します。

  5. [README ファイルを追加する] を選択します。

  6. [Create repository] (リポジトリの作成) をクリックします。

手順 2: ブランチを作成する

ブランチを使用すると、一度に異なるバージョンのリポジトリを使用できます。

既定では、リポジトリには、決定版ブランチと見なされる main という名前のブランチが 1 つ存在します。 リポジトリで main の追加のブランチを作成できます。

ブランチは、コードのメインのソースを変更せずに新しい機能をプロジェクトに追加する場合に役立ちます。 異なるブランチで行われた作業は、マージするまでメインのブランチには表示されません。これについてはこのガイドで後ほど説明します。 ブランチを使用すると、main にブランチをコミットする前に実験や編集を行うことができます。

main ブランチからブランチを作成すると、main のその時点のコピー (スナップショット) が作成されます。 ブランチの作業中に他のユーザーが main ブランチに変更を加えた場合は、その更新をプルできます。

この図は次のことを示しています。

  • main ブランチ
  • feature という名前の新しいブランチ
  • main にマージされる前に feature がたどるプロセス

2 つのブランチの図。 "feature" ブランチは "メイン" ブランチから分岐し、"変更のコミット"、"pull request の送信"、"提案された変更のディスカッション" の各ステージを経て、main にマージされます。

ブランチの作成

  1. hello-world リポジトリの [コード] タブをクリックします。

  2. ファイル リストの上で、main と表示されているドロップダウン メニューをクリックします。

    リポジトリ ページのスクリーンショット。 ブランチ アイコンに [main] のラベルの付いたドロップダウン メニューがオレンジ色の枠線で強調表示されています。

  3. テキスト ボックスにブランチ名の「readme-edits」を入力します。

  4. [ブランチの作成: main からの readme-edits] をクリックします。

    リポジトリのブランチ ドロップダウンのスクリーンショット。 "ブランチの作成: 'main' からの readme-edits" が濃いオレンジの枠線で囲まれています。

これで main と readme-edits の 2 つのブランチを作成しました。 今のところ、この 2 つはまったく同じように見えます。 次に、新しい readme-edits ブランチに変更を追加します。

手順 3: 変更を行いコミットする

前の手順で新しいブランチを作成後、GitHub を使用して新しい readme-edits ブランチ (main のコピー) のコード ページに移動しました。

リポジトリ内のファイルに変更を加えて保存できます。 GitHub では、保存された変更はコミットと呼ばれます。 各コミットには、特定の変更が行われた理由を説明するコミット メッセージが関連付けられています。 コミット メッセージでは、行ったこととその理由を他の共同作成者が理解できるように、変更内容の履歴がキャプチャされます。

  1. 作成した readme-edits ブランチで README.md ファイルをクリックします。
  2. をクリックしてファイルを編集します。
  3. エディターで簡単な自己紹介文を書きます。
  4. [変更のコミット] をクリックします。
  5. [変更のコミット] ボックスに、変更について説明するコミット メッセージを書き込みます。
  6. [Commit changes] をクリックします。

これらの変更は readme-edits ブランチ上の README ファイルにのみ行われるため、このブランチに main とは異なるコンテンツが含まれるようになりました。

手順 4: Pull request を開く

main とは別のブランチに変更が加わったため、pull request を開くことができます。

pull request は、GitHub でのコラボレーションの主な機能です。 pull request を開くと、変更を提案し、誰かにコントリビューションをレビューしてプルし、ブランチにマージするよう要求できます。 pull request では、両方のブランチのコンテンツの相違点 (差分) が表示されます。 変更、追加、差分は異なる色で表示されます。

コミットしたらすぐに、コードが完成していなくても、pull request を開き、ディスカッションを開始できます。

この手順では、独自のリポジトリで pull request を開き、その後自身でマージを行います。 これは、大規模なプロジェクトに取り組む前に GitHub フローを実践するのに最適な方法です。

  1. hello-world リポジトリの [pull request] タブをクリックします。

  2. [新しい pull request] をクリックします。

  3. [比較例] ボックスで、作成したブランチの readme-edits を選択して、main (元のブランチ) と比較します。

  4. [比較] ページの差分で変更内容を確認し、送信すべき内容であることを確認します。

    README.md ファイルの diff のスクリーンショット。 赤の 3 行には削除されるテキストが示され、緑の 3 行には追加されるテキストが示されています。

  5. [pull request の作成] をクリックします。

  6. pull request にタイトルを付け、変更内容の簡単な説明を記述します。 絵文字を含め、画像や gif をドラッグ アンド ドロップできます。

  7. [Pull request の作成] をクリックします。

pull request のレビュー

他のユーザーと共同作業を開始する場合は、ここでレビューを依頼します。 これにより、変更を main ブランチにマージする前に、コラボレーターが pull request にコメントしたり、変更を提案できます。

このチュートリアルでは pull request のレビューについては取り上げませんが、詳細については「プルリクエストのレビューについて」を参照してください。 または、GitHub Skills の "Reviewing pull requests" コースをお試しください。

手順 5: pull request をマージする

この最後の手順では、readme-edits ブランチを main ブランチにマージします。 pull request をマージすると、readme-edits ブランチの変更が main に組み込まれます。

場合によっては、pull request によって、main の既存のコードと競合するコードが変更される場合があります。 競合がある場合、GitHub は競合するコードについて警告し、競合が解決されるまでマージを禁止します。 競合を解決するコミットを行うか、pull request のコメントを使用して、チーム メンバーと競合について話し合うことができます。

このチュートリアルでは、競合は発生しないため、ブランチをメイン ブランチにマージする準備ができました。

  1. pull request の下部にある [Pull request のマージ] をクリックして、変更を main にマージします。
  2. [マージの確認] をクリックします。 要求が正常にマージされ、要求が閉じられたことを示すメッセージが表示されます。
  3. [ブランチの削除] をクリックします。 pull request がマージされ、変更が main に反映されたため、readme-edits ブランチを安全に削除できます。 プロジェクトをさらに変更する場合は、いつでも新しいブランチを作成し、このプロセスを繰り返すことができます。
  4. hello-world リポジトリの [コード] タブに戻り、main で発行された変更を確認します。

まとめ

このチュートリアルを完了することで、プロジェクトを作成し、GitHub に対して pull request を行う方法を学習しました。

その一環として、次の方法を学習しました。

  • リポジトリの作成。
  • 新しいブランチの開始および管理。
  • ファイルの変更、および GitHub へのそれらの変更のコミット。
  • pull request の開始およびマージ。

次のステップ

  • GitHub プロファイルを見ると、作業内容がコントリビューション グラフに反映されていることがわかります。
  • このチュートリアルで学んだスキルをもう一度練習したい場合は、GitHub Skillsの「GitHub入門」コースをお試しください。"Introduction to GitHub" コースをお試しください。
  • 次のチュートリアル「プロフィールの設定」では、プロファイルをカスタマイズする方法について説明します。また、GitHub に書き込むための基本的な Markdown 構文についても説明します。

参考資料