【IT用語】GitHub初心者の為の「アカウント登録からプルリクエスト」超入門書

IT用語

GitHubの使い方

開発現場では、分散型のバージョン管理システムであるGitの仕組みを利用したWebサービスを使う事が多いです。今回は、代表的なGitHubを使える様になりましょう。

GitHubとは?
リンクをコピーしました

GitHubとは、Gitのバージョン管理システムを利用したWebサービスの事です。よくGitと間違えられやすいですが、GitHubは、Gitの仕組みを利用したWebサービスになります。

Gitがよくわからない方は、【IT用語】Gitのバージョン管理の仕組みを基本から丁寧に解説!を参考にして下さい。

GitHubの特徴
リンクをコピーしました

GitHubは、「Social Coding」というスローガンを掲げています。Social Codingとは、「OSS」を複数人で開発する事です。

このコミュニティを軸にして、開発をスムーズに進行できるための機能(プルリクエスト、Issue機能、Wiki機能など)が沢山あります。共同開発によって、ソースコードの品質が上がり、技術者としてのスキルも高める事が出来ます。

無料プランと有料プラン
リンクをコピーしました

GitHubは、無料プランと有料プランがあります。
無料プランは、以前までリポジトリが無制限の公開(public)のみでしたが、プライベート(private)も無制限で利用出来る様になりました。

ただし、リポジトリに招待出来る人(コラボレーター)は、3人までなので注意して下さい。

有料プランは、1名ごとに月$7で利用する事が出来ます。無料プランとの違いは、下記の表で確認して下さい。

個人ユーサー向けプラン 料金 プラン内容
free(無料) $0 無制限のパブリックリポジトリ,無制限のプライベートリポジトリ
(コラボレーター3名まで),Issue作成およびバグトラッキング,プロジェクト管理
pro(有料) $7(月額) 無制限のパブリックリポジトリ,無制限のプライベートリポジトリ,
無制限のコラボレータ,Issue作成およびバグトラッキング,
プロジェクト管理,Pages, Wiki, ブランチの保護,コードオーナー,Insightsなどの機能

紹介したのは、個人向けユーザーのプランですが、GitHubは企業も多数利用しているので、企業向けのプランも存在しています。

詳しくは、GitHubプラン参考にして下さい。

GitHubのアカウント登録
リンクをコピーしました

githubを使うには、アカウントを登録する必要があります。

  1. 公式サイトで新規登録
  2. プランを選択する
  3. メールを確認する
  4. 登録完了メール確認

アカウント登録までは上記の4ステップで簡単に登録する事が出来ます。

1. 公式サイトで新規登録
リンクをコピーしました

下記のリンクから公式サイトにアクセスして、新規登録を行います。

GitHub公式サイト

必要事項(ユーザ名、メールアドレス、パスワード)を入力ます。パスワードは、7文字以上なので注意して下さい。

githubの新規登録

記入したら、「Sign up for GitHub」を選択して次に進みます。

2. プランを選択する
リンクをコピーしました

次に無料プランか有料プランを選択します。プランの内容は、先ほどの無料プランと有料プランをご確認下さい。

プラン選択

無料プランでも非公開のリポジトリを作成する事が出来るので、今回はプライベートを選択します。(※招待出来るコラボレータは3人までの制限あり)

3. メールを確認する
リンクをコピーしました

登録したメールアドレスにGitHubから確認メールが届きます。

確認メール

「Verify email address」ボタンを選択します。

4. 登録完了メール確認
リンクをコピーしました

「Welcome to GitHub!」というメールが届いたら、GitHubの登録が完了です。

完了メール

リポジトリ作成
リンクをコピーしました

GitHubにアカウント登録する事が出来たので、早速リポジトリを作成していきます。

1. ログインする
リンクをコピーしました

ログインしていない状態でしたら、まずは公式サイトでログインします。

GitHub公式サイトのログインページ

ログイン

アカウント新規作成で登録した情報を入力します。もしパスワードを忘れてしまった場合は、「Forgot password?」を選択して下さい。

2. 新規リポジトリ作成
リンクをコピーしました

サイドバーの「New」を選択します。

リポジトリ作成

新規リポジトリ作成ページに遷移するので、「Repository name」にリポジトリの名前を登録します。リポジトリが非公開の場合はPrivate、公開の場合はPublicを選択します。

新規リポジトリ登録ページ

また、リポジトリ作成時に「README」ファイルを作成する場合は、「Initialize this repository with a README」にチェックを入れます。

上記の項目を入力すると「Create repository(リポジトリの作成)」ボタンがクリック出来る様になっているので、選択してリポジトリ作成します。

リポジトリ作成後の操作確認
リンクをコピーしました

リポジトリが作成されると、リポジトリのURLが作成されます。

リポジトリ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」のページを表示します。

クローン手順

次にURLを取得する為に、緑色の「clone or download」ボタンを選択します。デフォルトでSSH用のURLになっているのでHTTPSを利用する方は、「Use 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」が表示されます。プルリクエストに必要な項目を入力します。

必要項目入力

❶ タイトル
プルリクエストのタイトルを入力します。コミットが1つだけの場合は、タイトルの初期値は、コミットメッセージになります。

❷ 概要
プルリクエストを確認する人に向けて、変更内容を入力します。Markdown形式で記述出来て、「Preview」を選択すると、Markdownで記述した内容を確認する事が出来ます。

❸ その他設定項目
プルリクエストを作成する際に下記の項目も設定する事が出来ます。

その他設定項目

ラベルのデフォルトの内容は、GitHubヘルプの「ラベルについて」をご確認下さい。ラベルは、「Edit labels」から追加する事が出来ます。

プルリクエストのレビューを行う
リンクをコピーしました

GitHubには、プルリクエストのレビューを行う際に、ソースコードの差分を分かりやすく表示してくれたり、コメントを記述したり便利な機能があります。

プルリクエストのレビューの手順と一緒に機能を確認していきましょう。

1. プルリクエストを選択する
リンクをコピーしました

リポジトリの「Pull requests」からレビューするプルリクエストを選択します。

2. コメントする
リンクをコピーしました

「Files changed」を選択して、ソースコードの差分を確認します。

Files changedを選択する

コメントを追加したい行をカーソルで当てて、青いコメントアイコンを選択します。背景色が赤色のコードが削除されたコードで、緑色のコードが追加されたコードです。
コメントアイコン

コメントを記述出来るコメントフィールドが表示されるので、コメントを記述していきます。記述したら「[Start a review] 」を選択します。レビューを既に開始していた場合「[Add review comment] 」を選択します。

コメントフィールド

3. ファイルをレビュー済としてマークする
リンクをコピーしました

レビューしたファイルは、レビュー済としてマークする事ができます。

レビュー済にする

レビュー済のファイルに、右側にある「Viewed」のチェックマークを入れます。

チェックマークを入れる

「Viewed」のチェックマークを入れると、ファイルが閉じてくれます。

4. レビューを提出する
リンクをコピーしました

プルリクエスト内のレビューを終えたら、レビューを提出します。「Files changed」を選択して、右にある緑色の「Review changes」ボタンを選択します。

Review changesを選択する

「Review changes」ボタンを選択すると、変更に対するフィードバックをまとめたコメントを記述する事が出来ます。

レビューの種類

そして、赤枠で囲ってあるレビューの種類を選択します。「Submit review」を選択して提出します。

レビューの種類 内容
Comment フィードバックを提出のみ、変更を承認しない
Approve フィードバックを提出する、プルリクエストの変更をマージすることを承認する
Request changes プルリクエストのマージ前に対処しなければならない問題をフィードバックする

承認されたプルリクエストをマージする
リンクをコピーしました

プルリクエストで変更を承認されたら、マージを行います。「Pull requests」の下にある下記の緑のボタンを選択します。

マージする

ボタンをクリックすると、プルリクエストのタイトルが表示されるので確認して大丈夫だったら「Confirm merge」を選択します。

プルリクエストタイトル確認

マージが終わると、下記の様な表示になります。「Delete branch」は、マージが終わったブランチを削除する事が出来ます。特に必要がなければ削除しておきましょう。

ブランチ削除

まとめ
  • GitHubとは、Gitのバージョン管理システムを利用したWebサービスの事です
  • 開発のソースコードを管理する為に利用されます
  • 開発をスムーズに進行できるための機能が豊富にあります