読者です 読者をやめる 読者になる 読者になる

スタートアップが初めてGitHubを使う際の手順

先日、スタートアップの方からGitHubの使い方について質問を受けたのでまとめてみます。この記事を読んで役に立つ可能性があるのは

  1. これからGitHubを使ってみようとしている
  2. ソースコードを管理したいが公開はしたくない
  3. エンジニア歴が短かったり非エンジニアだったりする

という方々に対してなので、これらに当てはまらない方はそっとブラウザを閉じていただければと思います。

まず最初に、「Organizationを作る or 作らない」によって手順が若干異なるので、決めてしまいましょう。Organizationというのはいわゆる「会社用のアカウント」みたいなもので、権限の管理(◯◯さんはソースコードを見るだけ、△△さんはソースコードを改変することもできる、等)が楽になるというメリットがあり、毎月の利用料金がかさむというデメリットがあるもの、と考えていただければ概ね間違っていないかと思います。

  1. リポジトリを新規に作る頻度が極めて少ない(≒ 頻度が上がるのはだいぶ先の予定)
  2. 携わるエンジニアの数が少ない(≒ エンジニアの数が増えるのはだいぶ先の予定)
  3. 支出をなるべく低価格に抑えたい(毎月7ドル or 25ドルの差が出ることがあります)

これら全てに当てはまる方はしばらくは「Organizationを作らない」という方針で大丈夫かなと思います。 いずれか当てはまらないものがあればOrganizationを作ってしまいましょう。あとで作ることもできますので、 何かしら不安があれば作らない方法で大丈夫だと思います。(個人的には最初から作っておいた方が気持ち良いのでオススメです。)

Organizationを作るにせよ作らないにせよ、事前準備としてGitHubアカウントを作っておいてください。アカウントの作成は https://github.com/ にアクセスして、usernameYour emailCreate a passwordを適宜入力するだけで簡単に作成できます。

Organizationを作る場合の方法

手順1. Organization(組織)を作る

GitHubにログインした状態でhttps://github.com/にアクセスし、画面左上の自分のアカウント名をクリックして +Create organization をクリックします。

f:id:phero:20150510134727p:plain:h180

あとは画面の指示に従ってカード情報等の必要な項目を入力したり選択したりするだけです。最初は最も安いBronzeプラン(月額25ドル)を選択しておけば大丈夫です。

手順2. Teamを作成する

Organizationを作る最大のメリットの1つがこの「Teamを作れるようになる」というものです。 ではTeamとは何かというと、以下の箇条書きをご覧いただければ存在意義がわかるかと思います。

  1. Teamは個人のGitHubアカウントの集合である
  2. TeamはOrganizationに属する
  3. Team単位で読み込み権限/書き込み権限/管理者権限を設定できる

つまり上述の「権限の管理が楽になる」というメリットを実現するための機能がTeamということですね。

Teamの作成は https://github.com/ の画面左上から自分のアカウント名をクリックし、Manage organizationsをクリックします。

f:id:phero:20150510151931p:plain:h240

(あるいは直接 https://github.com/<先ほど作成したOrganization名> にブラウザからアクセスしてもOKです。)

続けて画面右側の Create new team のボタンをクリックします。

f:id:phero:20150525104457p:plain:h240

続けて表示される画面でチーム名チームの説明(任意)アクセス権限を適宜入力し、Create team ボタンをクリックします。

手順3. Teamに関係者を追加する

今ブラウザでは https://github.com/orgs/<Organization名>/teams/<Team名> のページが表示されているかと思いますが、画面右上のAdd a personから「招待したい人のGitHubアカウント名」を入力(下図参照)すればその人がTeamに属するようになり、指定された権限でアクセスできるようになります。

f:id:phero:20150525104920p:plain:h240

ここで気を付けなければならないのは、「決して入力間違いを起こさないこと」です。もしタイプミスなどで他のアカウント名を入力してしまうと、どこぞの誰かもわからない謎の人がソースコードを読むことが出来てしまうという状態になりますので、極めて危険です。

手順4. リポジトリを作る

https://github.com/ にアクセスし、Organizationのページに進みます。

f:id:phero:20150527145000p:plain:h240

続けて画面右側のRepositoriesの項目から、+ New repository のボタンをクリックします。

f:id:phero:20150527145501p:plain:h120

手順5. リポジトリにTeamを加える

上記手順4で作成したリポジトリのページ( https://github.com/<Organization名>/<リポジトリ名> )にアクセスし、画面右側のSettingsをクリックします。

f:id:phero:20150527150320p:plain:h240

画面左側のメニューのCollaboratorsをクリックします。

f:id:phero:20150527150619p:plain:h240

Select teamから、先ほど作ったTeam名を選択します。

f:id:phero:20150527150729p:plain:h240

これで指定したTeamから指定したリポジトリにアクセスできるようになりました。

以上でOrganizationを作る場合の設定は完了となります。


Organizationを作らない場合の方法

もしOrganizationを作らない場合は、個人アカウントでプライベートリポジトリを作成し、そのリポジトリにおいて特定のGitHubユーザーに対して権限を付与するという形で複数名で開発できるようになります。

手順1. リポジトリを作る

https://github.com/ から、画面右側の+ New repository(緑色のボタン)をクリックし、新たなリポジトリを作成します。

手順2. リポジトリにアクセスできる人を増やす

画面右側のメニューからSettingsをクリックします。

f:id:phero:20150527151355p:plain:h240

画面左側のメニューからCollaboratorsをクリックします。

f:id:phero:20150527151511p:plain:h160

Search by username or full nameにGitHubアカウントを入力し、右側のAdd collaboratorボタンをクリックします。

これで指定されたアカウントからリポジトリに対して読み書きができるようになりました。


割りと長めになってしまいましたが、上記が「1人でGitHubを使わずにでもGitを利用して開発してたけど、開発者が自分だけではなくなったのでこれを機にGitHubを使ってみよう」という方の参考になれば幸いです。

GitHubに詳しくなりたい方は手始めに以下のような本をお読みになると良いかもしれません。(プルリクのことを"プルリ"と呼ぶのは初めて耳にしましたが)

Web制作者のためのGitHubの教科書 チームの効率を最大化する共同開発ツール

Web制作者のためのGitHubの教科書 チームの効率を最大化する共同開発ツール