リポジトリをフォークする
「フォーク」はリポジトリのコピーです。 リポジトリをフォークすることにより、オリジナルのプロジェクトに影響を与えることなく変更を自由にテストできます。
一般的にフォークは、他のユーザのプロジェクトへの変更を提案するため、あるいは他のユーザのプロジェクトを自分のアイディアの出発点として活用するために使用します。
他のユーザのプロジェクトへの変更を提案する
変更提案のためにフォークを使用する良い例は、バグの修正です。 見つけたバグから Issue をログするのではなく、以下のことができます:
- リポジトリをフォークする。
- 修正する。
- プロジェクトのオーナーにプルリクエストを送信する。
プロジェクトのオーナーがあなたの作業内容を気に入ったら、あなたの修正がオリジナルのリポジトリにプルされるかもしれません。
他のユーザのプロジェクトを自分のアイディアの出発点として活用する。
オープンソースの中心理念は、コードを共有することでより優れた信頼性のあるソフトウェアを作成できる、というものです。
他のユーザのプロジェクトのフォークからパブリックリポジトリを作成する際は、そのプロジェクトがどう共有されるべきかを定義するライセンスファイルを含めるようにしてください。
オープンソースに関する詳しい情報、特にオープンソースプロジェクトの立ち上げと成長させる方法について、 Open Source Guides を作成しました。これは、オープンソースプロジェクトのためのリポジトリの作成と管理にに関するベストプラクティスを推奨することによって、健全なオープンソースコミュニティの育成を支援しようとするものです。 オープンソースコミュニティの管理に関する無料の GitHub Learning Lab コースを利用することもできます。
リポジトリのフォークの例
リポジトリのフォークは、2 つのステップからなるシンプルなプロセスです。 練習用のリポジトリを用意しましたので、ぜひお使いください。
- 使用している GitHub Enterprise Serverインスタンス で、octocat/Spoon-Knife リポジトリに移動します。
- ページの右上にある [Fork] をクリックします。
これで完了です。 オリジナルの octocat/Spoon-Knife リポジトリのフォークができあがりました。
フォークを同期させる
上流の、またはオリジナルのリポジトリへの変更を提案するために、プロジェクトをフォークする場合があります この場合、自分のフォークを上流のリポジトリと定期的に同期させるとよいでしょう。 これには、コマンドラインで Git を使用する必要があります。 先程フォークした同じ octocat/Spoon-Knife リポジトリを使用して、上流リポジトリの設定を練習できます。
ステップ 1: Git をセットアップする
まだ設定していない場合は、まず Git を設定します。 Git からの 使用している GitHub Enterprise Serverインスタンス への認証を設定することも忘れないでください。
ステップ 2: フォークのローカルクローンを作成する
今、Spoon-Knife リポジトリのフォークがありますが、お使いのコンピュータにはそのリポジトリ内のファイルはありません。 フォークのクローンをコンピュータにローカルで作成しましょう。
-
GitHub Enterprise で、Spoon-Knife リポジトリの自分のフォークに移動します。
-
Under the repository name, click Clone or download.
-
To clone the repository using HTTPS, under "Clone with HTTPS", click . To clone the repository using an SSH key click Use SSH, then click .
-
ターミナルターミナルGit Bashターミナル を開いてください。
-
git clone
と入力し、前の手順でコピーした URL を貼り付けます。 次のようになるはずです (YOUR-USERNAME
はあなたの GitHub Enterprise ユーザ名に置き換えてください):$ git clone https://hostname/YOUR-USERNAME/Spoon-Knife
-
Enter を押します。 これで、ローカルにクローンが作成されます。
$ git clone https://hostname/YOUR-USERNAME/Spoon-Knife > Cloning into `Spoon-Knife`... > remote: Counting objects: 10, done. > remote: Compressing objects: 100% (8/8), done. > remove: Total 10 (delta 1), reused 10 (delta 1) > Unpacking objects: 100% (10/10), done.
Spoon-Knife リポジトリのフォークのローカルのコピーができました。
ステップ 3: Git を構成して、自分のフォークとオリジナルの Spoon-Knife リポジトリを同期させる
オリジナルのリポジトリへの変更を提案するためにプロジェクトをフォークする場合は、オリジナルまたは上流のリポジトリから、フォークのローカルのクローンへと、変更をプルするように Git を構成できます。
-
GitHub Enterprise で、octocat/Spoon-Knife リポジトリに移動します。
-
Under the repository name, click Clone or download.
-
To clone the repository using HTTPS, under "Clone with HTTPS", click . To clone the repository using an SSH key click Use SSH, then click .
-
ターミナルターミナルGit Bashターミナル を開いてください。
-
ディレクトリを、「ステップ 2: フォークのローカルクローンを作成する」でクローンしたフォークの場所に変更します。
- ホームディレクトリに移動するには、
cd
とだけ入力します。 - 現在のディレクトリのファイルとフォルダを一覧表示するには、
ls
と入力します。 - 一覧表示されたディレクトリのいずれかにアクセスするには、
cd your_listed_directory
と入力します。 - 1 つ上のディレクトリに移動するには、
cd ..
と入力します。
- ホームディレクトリに移動するには、
-
git remote -v
と入力して Enter キーを押します。 フォーク用に現在構成されているリモートリポジトリが表示されます。$ git remote -v > origin https://hostname/YOUR_USERNAME/YOUR_FORK.git (fetch) > origin https://hostname/YOUR_USERNAME/YOUR_FORK.git (push)
-
git remote add upstream
と入力し、ステップ 2 でコピーした URL を貼り付けて Enter キーを押します。 次のようになります:$ git remote add upstream https://hostname/octocat/Spoon-Knife.git
-
フォーク用に指定した新しい上流リポジトリを確認するには、再度
git remote -v
と入力します。 フォークの URL がorigin
として、オリジナルのリポジトリの URL がupstream
として表示されるはずです。$ git remote -v > origin https://hostname/YOUR_USERNAME/YOUR_FORK.git (fetch) > origin https://hostname/YOUR_USERNAME/YOUR_FORK.git (push) > upstream https://hostname/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (fetch) > upstream https://hostname/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (push)
これで、いくつかの Git コマンドでフォークと上流リポジトリの同期を維持できます。 詳細は「フォークを同期する」を参照してください。
次のステップ
フォークに対して行える変更に上限はありません。次のようなものがあります:
- Creating branches: Branches allow you to build new features or test out ideas without putting your main project at risk.
- プルリクエストをオープンする: オリジナルのリポジトリにコントリビュートしたい場合は、プルリクエストを送信して、オリジナルの作者に自分のフォークをリポジトリへプルするようリクエストを送信できます。
フォークする他のリポジトリを見つける
リポジトリをフォークしてプロジェクトへのコントリビューションを開始しましょう。 自分のユーザアカウントや自分がリポジトリの作成権限を持つOrganizationに、任意のパブリックリポジトリをフォークできます。 詳細は「Organization の権限レベル」を参照してください。
自分のユーザアカウントや自分がリポジトリの作成権限を持つGitHub TeamあるいはGitHub Enterprise上のOrganizationに、あなたがアクセスできる任意のプライベートリポジトリをフォークできます。
おめでとうございます
リポジトリをフォークし、フォークのクローンを練習し、上流リポジトリを構成しました。 次に何をしたいですか?
- Git をセットアップする
- 「リポジトリを作成する」
- リポジトリのフォーク
- 交流する
- GitHub コミュニティフォーラムで世界中の人々とつながりましょう