更新日:
【IT用語】 GitHub初心者のアカウント登録からプルリクエスト超入門書
GitHubとは、Gitのバージョン管理システムを利用したWebサービスの事です。よくGitと間違えられやすいですが、GitHubは、Gitの仕組みを利用したWebサービスになります。
開発現場では、分散型のバージョン管理システムであるGitの仕組みを利用したWebサービスを使う事が多いです。今回は、代表的なGitHubについて解説します。
GitHubの基礎知識
この章では、Githubの基礎知識について解説します。
GitHubについて
GitHubは、「Social Coding」というスローガンを掲げています。Social Codingとは、「OSS」を複数人で開発する事です。
このコミュニティを軸にして、開発をスムーズに進行できるための機能(プルリクエスト、Issue機能、Wiki機能など)が沢山あります。共同開発によって、ソースコードの品質が上がり、技術者としてのスキルも高める事が出来ます。
「OSS」は、「オープンソース・ソフトウェア(Open Source Software)」の略語です。ソースコードが公開されていて利用や改変、再配布が作者から許可されているソフトウェアの事です。 オープンソースと言っても全て自由という訳ではなく、改変したり、再配布する場合は、細かいライセンスが存在するので、OSSごとに確認が必要なので注意して下さい。
無料プランと有料プラン
GitHubは、無料プランと有料プランがあります。
無料プランは、以前までリポジトリが無制限の公開(public)のみでしたが、プライベート(private)も無制限で利用出来る様になりました。
ただし、リポジトリに招待出来る人(コラボレーター)は、３人までなので注意して下さい。
有料プランは、1名ごとに月$4で利用する事が出来ます。無料プランとの違いは、下記の表で確認して下さい。
| 個人ユーサー向けプラン | 料金 | プラン内容 |
|---|---|---|
| Free(無料) | $0 | 無制限のパブリックリポジトリ,無制限のプライベートリポジトリ (コラボレーター３名まで),Issue作成およびバグトラッキング,プロジェクト管理 |
| Team(有料) | $4(月額) | 無制限のパブリックリポジトリ,無制限のプライベートリポジトリ, 無制限のコラボレータ,Issue作成およびバグトラッキング, プロジェクト管理,Pages, Wiki, ブランチの保護,コードオーナー,Insightsなどの機能 |
紹介したのは、個人向けユーザーのプランですが、GitHubは企業も多数利用しているので、企業向けのプランも存在しています。
詳しくは、GitHubプラン参考にして下さい。
pro(有料)プランですが、学生の場合無料で登録する事が出来ます。free(無料)プランでもプライベートリポジトリが無制限に利用する事が出来ますが、その他のpro(有料)プラン独自の機能があるので、学生の場合はこちらの方がおすすめです。
GitHubのアカウント登録
githubを使うには、アカウントを登録する必要があります。
まず、GitHubの公式サイト（GitHub.com）にアクセスし、アカウントを作成するか、既にアカウントを持っている場合はログインします。
アカウントを作成するには右上の「Sign up」をクリックします。
次にメールアドレス、パスワード、ユーザー名を順番に入力します。パスワードは少なくとも15文字、または数字と小文字を含む少なくとも8 文字である必要があります。ユーザー名には英数字または単一のハイフンのみを含めることができ、ハイフンで始まったり終わったりすることはできません。
全て入力したら「Continue」をクリックします。
するとアカウントの確認画面になるので、質問に回答します。
次に登録したメールアドレスにメールが届くので、メール内のコードを入力します。
以下のログイン画面になれば登録完了です。
ログインすると以下の画面になります。
それぞれ選択して「Continue」をクリックします。
以下の画面になるので、同じように選択して「Continue」をクリックします。
プラン選択画面になるので「Continue for free」を選択します。
選択後、以下のようにダッシュボードが表示されれば完了です。
▼ GitやGitHubについて基礎から手を動かして学びたい方におすすめの１冊！実務に役立つ開発手法についても丁寧に解説してあります。
Pull Requestによる開発の変革 WEB+DB PRESS plus！
リポジトリ作成
GitHubにアカウント登録する事が出来たので、早速リポジトリを作成していきます。
1. ログインする
ログインしていない状態でしたら、まずは公式サイトでログインします。
アカウント新規作成で登録した情報を入力します。もしパスワードを忘れてしまった場合は、「Forgot password?」を選択して下さい。
2. 新規リポジトリ作成
ダッシュボードの左サイドバーの「Create repository」を選択します。
新規リポジトリ作成ページに遷移するので、「Repository name」にリポジトリの名前を登録します。リポジトリが非公開の場合はPrivate、公開の場合はPublicを選択します。
また、リポジトリ作成時に「README」ファイルを作成する場合は、「Initialize this repository with:」の「Add a README file」にチェックを入れます。
上記の項目を入力し、「Create repository」ボタンをクリックすると新規のレポジトリが作成されます。
「README」ファイルとは、GitHubに自分が作成したツールなどを公開する場合に、ツールの使い方や宣伝、インストール方法などを記載するファイルのことです。
リポジトリ作成後の操作確認
READMEを作成せずにリポジトリが作成されると、リポジトリのURLが作成されます。
また、このページにはリポジトリ作成後の操作方法が「…or create a new repository on the command line」と「…or push an existing repository from the command line」が記載されています。ローカルリポジトリの状況によって、操作方法が分かれます。
| コマンド | 内容 | 補足 |
|---|---|---|
| git init | 新規にリポジトリを作成する | ディレクトリにリポジトリを構成する .gitファイルが作成される |
| git add/commit/push | コマンド操作を参照 | |
| git remote add | リモートリポジトリの追加 |
※ 後述詳しく解説 |
また、上記の操作はHTTPSのコマンドになりますので、SSHのコマンド操作で行う場合は、ページ上部の「Quick setup — if you’ve done this kind of thing before」のHTTPSをSSHに切り替えて下さい。
「SSH」とは、ネットワークで繋がっている自分以外のコンピュータ(リモートコンピュータ)と通信するためのプロトコルのことです。ネットワーク上の通信内容を全て暗号化してくれるので安全に通信を行う事が出来ます。
既存のリモートリポジトリ複製
既に作成されているリモートリポジトリを他人の変更履歴なども含めて、全て複製する事が出来ます。 この操作をクローン(Clone)と呼びます。
クローンすると、別のマシンにローカルリポジトリを作成する事が出来ます。
1. リモートリポジトリの確認
操作手順は、シンプルです。
まずは、クローンしたいリモートリポジトリのページにアクセスし「Code」のページを表示します。
デフォルトでSSH用のURLになっているのでHTTPSを利用する方は、「HTTPS」を選択します。
2. コマンド操作
ローカルのパソコンで「ターミナル」を開き、クローンするディレクトリで下記のコマンドを打ちます。
1
$ git clone <url>
ディレクトリにリモートリポジトリのディレクトリがクローンされているか確認してみてください。
プルリクエストを作成する
プルリクエスト(PullRequest)とは、Gitの操作ではなくGitHubが提供する機能です。ローカルリポジトリのソースコードの変更・更新をわかりやすく表示し、他の開発者に通知します。
自身が開発した追加機能や改修などを他の開発者に確認してもらう事で、バグが起こりにくい開発プロセスになります。この様な目的で、ソースコードを検査・修正する事を「コードレビュー」と言います。
1. Pull requestsページを表示
GitHub上でプルリクエストを作成します。前提として、作業変更・更新したものをローカルリポジトリからリモートリポジトリにプッシュ(push)してアップロードしてあるものとします。
ローカルリポジトリからリモートリポジトリにプッシュ(push)の方法がわからない方は、バージョン管理の流れをご確認下さい。
GitHubのリポジトリの「Pull requests」を表示して緑の「New Pull request」ボタンを選択します。
2. ブランチを選択する
「Compare changes」と表示されブランチを選択する事が出来るので、プルリクエストするブランチを選択します。
右側のcompareがプルリクエスト対象ブランチになります。左側がマージ先のブランチです。
3. 必要項目入力
プルリクエスト対象ブランチを選択すると、「Open a pull request」が表示されます。プルリクエストに必要な項目を入力します。
❶ タイトル
プルリクエストのタイトルを入力します。コミットが１つだけの場合は、タイトルの初期値は、コミットメッセージになります。
❷ 概要
プルリクエストを確認する人に向けて、変更内容を入力します。Markdown形式で記述出来て、「Preview」を選択すると、Markdownで記述した内容を確認する事が出来ます。
❸ その他設定項目
プルリクエストを作成する際に下記の項目も設定する事が出来ます。
ラベルのデフォルトの内容は、GitHubヘルプの「ラベルについて」をご確認下さい。ラベルは、「Edit labels」から追加する事が出来ます。
プルリクエストのレビューを行う
GitHubには、プルリクエストのレビューを行う際に、ソースコードの差分を分かりやすく表示してくれたり、コメントを記述したり便利な機能があります。
プルリクエストのレビューの手順と一緒に機能を確認していきましょう。
1. プルリクエストを選択する
リポジトリの「Pull requests」からレビューするプルリクエストを選択します。
2. コメントする
「Files changed」を選択して、ソースコードの差分を確認します。
コメントを追加したい行をカーソルで当てて、青いコメントアイコンを選択します。背景色が赤色のコードが削除されたコードで、緑色のコードが追加されたコードです。
コメントを記述出来るコメントフィールドが表示されるので、コメントを記述していきます。記述したら「[Start a review] 」を選択します。レビューを既に開始していた場合「[Add review comment] 」を選択します。
3. ファイルをレビュー済としてマークする
レビューしたファイルは、レビュー済としてマークする事ができます。
レビュー済のファイルに、右側にある「Viewed」のチェックマークを入れます。
「Viewed」のチェックマークを入れると、ファイルが閉じてくれます。
4. レビューを提出する
プルリクエスト内のレビューを終えたら、レビューを提出します。「Files changed」を選択して、右にある緑色の「Review changes」ボタンを選択します。
「Review changes」ボタンを選択すると、変更に対するフィードバックをまとめたコメントを記述する事が出来ます。
そして、赤枠で囲ってあるレビューの種類を選択します。「Submit review」を選択して提出します。
| レビューの種類 | 内容 |
|---|---|
| Comment | フィードバックを提出のみ、変更を承認しない |
| Approve | フィードバックを提出する、プルリクエストの変更をマージすることを承認する |
| Request changes | プルリクエストのマージ前に対処しなければならない問題をフィードバックする |
承認されたプルリクエストをマージする
プルリクエストで変更を承認されたら、マージを行います。「Pull requests」の下にある下記の緑のボタンを選択します。
ボタンをクリックすると、プルリクエストのタイトルが表示されるので確認して大丈夫だったら「Confirm merge」を選択します。
マージが終わると、下記の様な表示になります。「Delete branch」は、マージが終わったブランチを削除する事が出来ます。特に必要がなければ削除しておきましょう。
GitHubには、他にも様々な便利な機能があります。例えば、GitHubのヘッダーにある検索フォームはコードを検索する事が出来ます。リポジトリからクローンしなくてもブラウザでコードを確認する事が出来るので便利です。
この記事のまとめ
- GitHubとは、Gitのバージョン管理システムを利用したWebサービスのこと
- 開発のソースコードを管理する為に利用される
- 開発をスムーズに進行できるための機能が豊富にある
