概要
GitHub を初めて使用する人に向けの "Hello World" プロジェクトを実際に試してみる
このプロジェクトで学べること
- リポジトリの作成および使用方法
- ブランチの管理方法
- ファイルを変更して GitHub にプッシュする方法
- プルリクエストを行いマージする方法
キーワード
- リポジトリ(repository)
- ** ブランチ(branch)**
- コミット(commit)
- コミットメッセージ(commit message)
- プルリクエスト(pull request)
Step1. リポジトリの作成
リポジトリ(repository)
フォルダやファイル類などプロジェクトに必要なものを保存しておく場所
README(プロジェクトに関する情報を記述したファイル)の作成も推奨
リポジトリの新規作成
- GitHub へログイン後、画面右上の「+」をクリックし、「New repository」を選択
- 下記の画面が表示されるので、「Repository name」に
hello-worldと入力 - 「Description」に説明文を任意で入力
- 「Initialize this repository with a README」にチェックを入れる※1
- 「Create repository」ボタンをクリック
※1 「Repository name」および「Description」に入力した内容が README.md ファイルとして保存される
Step2. ブランチの作成
ブランチ(branch)
現在リリースしているバージョンのメンテナンスをしながら、機能追加やバグ修正を行うような場合に、複数のバージョン管理を行うための機能
デフォルトでは masterブランチを持っている
masterから別のブランチを作成するにはコピーかスナップショットをとる
masterからfutureブランチを作成し、futureに様々な変更を加えてmasterへマージする例
ブランチの新規作成
-
hello-worldリポジトリへ移動 - 「Branch: master」ボタンをクリック
- テキストボックスに新しいブランチ名の
readme-editsを入力 - 「Create branch」ボタンをクリック
これでmasterとreadme-editsの2つのブランチを持ったことになる
今はどちらのブランチも同じ内容だが、これから新しいブランチに変更を加えていく
Step3. 変更とコミット
それではreadme-editsブランチに対して変更を加える
GitHub では変更を保存することを**コミット(commit)と言う
コミットにはコミットメッセージ(commit message)**という変更に対する説明文を付与する
これにより、誰が・いつ・なぜその変更をしたのかを変更履歴として把握できるようになる
変更とコミットを行う
-
README.mdファイルをクリック - 右上の鉛筆アイコンをクリックして編集
- エディターで変更内容を記入
- コミットメッセージを下部の「Commit changes」に記入
- 「Commit changes」ボタンをクリック
これらの変更はreadme-editsブランチのREADMEファイルにのみ反映される
よってmasterとは違った内容になっている
Step4. プルリクエスト
**プルリクエスト(pull request)**はGitHubでコラボレーションする上での中心的な機能
もし何かの変更を行い、それをレビューして欲しい場合、プルリクエストを使用することで他の人に取り込んでもらいマージしてもらうことができる
プルリクエストは変更・追加・削除した点が緑や赤で表示される
コミットしたら即座にプルリクエストおよびディスカッションを開始できる
また、Github の@mention systemを利用することで特定の個人やチームに対して通知を飛ばし、意見を求めることができる
それでは自分のリポジトリにプルリクエストを行いマージしてみよう
READMEに対するプルリクエストを行う
- 「Pull requests」タブをクリックし、右側の「New pull request」ボタンをクリック
- base:
masterのまま、compare:readme-editsを選択 - ページ下部で変更点を見て、自分が変更したい内容か確認
- 自分が変更したい内容絵あれば、「Create pull request」ボタンをクリック
- プルリクエストに題名と説明を記入し、「Create pull request」ボタンをクリック
Tip: emojiや画像もプルリクエストのコメントに使用可能
EMOJI CHEAT SHEET
Step5. マージ
最後のステップとして、readme-editsブランチをmasterブランチにマージする
-
masterへ変更をマージするため、「Merge pull request」ボタンをクリック - 「Confirm merge」をクリック
- 変更が組み込まれたので、「Delete branch」をクリックしてブランチを削除する
やったぁ！
これでこのチュートリアルは完了
プロジェクトを作成してプルリクエストを行うことができた
ここで学んだこととは、
- オープンソースリポジトリの作成
- 新しいブランチの作成と管理
- ファイルの編集と GitHub へのコミット
- プルリクエストによるマージ
GitHub のプロファイルから自分の Contribution を見てみよう
もっとプルリクエストを学びたい場合はGitHub Flow Guideを読んでみよう
また、オープンソースプロジェクトに参加した場合はGitHub Exploreにも行ってみるとよい
Tip: 他にも、Guides, YouTube ChannelやOn-Demand Traningもチェックしてみる良い