Skip to main content

Fork a repo

A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project.

About forks

Most commonly, forks are used to either propose changes to someone else's project to which you do not have write access, or to use someone else's project as a starting point for your own idea. You can fork a repository to create a copy of the repository and make changes without affecting the upstream repository. For more information, see "Working with forks."

Propose changes to someone else's project

For example, you can use forks to propose changes related to fixing a bug. Rather than logging an issue for a bug you have found, you can:

  • Fork the repository.
  • Make the fix.
  • Submit a pull request to the project owner.

Use someone else's project as a starting point for your own idea.

Open source software is based on the idea that by sharing code, we can make better, more reliable software. For more information, see the "About the Open Source Initiative" on the Open Source Initiative.

For more information about applying open source principles to your organization's development work on your GitHub Enterprise Server instance, see GitHub's white paper "An introduction to innersource."

When creating your public repository from a fork of someone's project, make sure to include a license file that determines how you want your project to be shared with others. For more information, see "Choose an open source license" at choosealicense.com.

オープン ソースに関する詳しい情報、特にオープン ソース プロジェクトの立ち上げと成長させる方法について、「オープン ソース ガイド」を作成しました。これは、オープン ソース プロジェクトのためのリポジトリの作成と管理に関するベスト プラクティスを推奨することで、健全なオープン ソース コミュニティの育成を支援するものです。 オープン ソース コミュニティの維持に関する無料の GitHub Skills コースを受講することもできます。

Prerequisites

If you have not yet, you should first set up Git. Don't forget to set up authentication to your GitHub Enterprise Server instance from Git as well.

Forking a repository

You might fork a project to propose changes to the upstream, or original, repository. In this case, it's good practice to regularly sync your fork with the upstream repository. To do this, you'll need to use Git on the command line. You can practice setting the upstream repository using the same octocat/Spoon-Knife repository you just forked.

  1. On your GitHub Enterprise Server instance, navigate to the octocat/Spoon-Knife repository.
  2. In the top-right corner of the page, click Fork. Fork button
  3. Select an owner for the forked repository. Create a new fork page with owner dropdown emphasized
  4. By default, forks are named the same as their parent repositories. You can change the name of the fork to distinguish it further. Create a new fork page with repository name field emphasized
  5. Optionally, add a description of your fork. Create a new fork page with description field emphasized
  6. Choose whether to copy only the default branch or all branches to the new fork. For many forking scenarios, such as contributing to open-source projects, you only need to copy the default branch. By default, only the default branch is copied. Option to copy only the default branch
  7. Click Create fork. Emphasized create fork button

Note: If you want to copy additional branches from the parent repository, you can do so from the Branches page. For more information, see "Creating and deleting branches within your repository."

GitHub CLI の詳細については、「GitHub CLI について」を参照してください。

To create a fork of a repository, use the gh repo fork subcommand.

gh repo fork REPOSITORY

To create the fork in an organization, use the --org flag.

gh repo fork REPOSITORY --org "octo-org"

Cloning your forked repository

Right now, you have a fork of the Spoon-Knife repository, but you do not have the files in that repository locally on your computer.

  1. On your GitHub Enterprise Server instance, navigate to your fork of the Spoon-Knife repository.

  2. ファイルのリストの上にある [コード] をクリックしてください。 [コード] ボタン

  3. リポジトリの URL をコピーします。

    • HTTPS を使ってリポジトリをクローンするには、[HTTPS] の下の をクリックします。
    • 組織の SSH 認証局から発行された証明書を含む SSH キーを使用してリポジトリをクローンするには、 [SSH] の順にクリックします。
    • GitHub CLI を使ってリポジトリをクローンするには、 [GitHub CLI] の順にクリックします。 GitHub CLI でリポジトリをクローンするための URL をコピーするためのクリップボード アイコン
  4. [ターミナル][ターミナル][Git Bash] を開きます。

  5. カレントワーキングディレクトリを、ディレクトリをクローンしたい場所に変更します。

  6. Type git clone, and then paste the URL you copied earlier. It will look like this, with your GitHub Enterprise Server username instead of YOUR-USERNAME:

    $ git clone https://ホスト名/YOUR-USERNAME/Spoon-Knife
  7. Press Enter. Your local clone will be created.

    $ git clone https://ホスト名/YOUR-USERNAME/Spoon-Knife
    > Cloning into `Spoon-Knife`...
    > remote: Counting objects: 10, done.
    > remote: Compressing objects: 100% (8/8), done.
    > remote: Total 10 (delta 1), reused 10 (delta 1)
    > Unpacking objects: 100% (10/10), done.

GitHub CLI の詳細については、「GitHub CLI について」を参照してください。

To create a clone of your fork, use the --clone flag.

gh repo fork REPOSITORY --clone=true
  1. [ファイル] メニューの [リポジトリの複製] をクリックします。

    Mac アプリケーション内の [Clone] メニューオプション

    Windows アプリケーション内の [Clone] メニューオプション

  2. クローンしたいリポジトリの場所に対応するタブをクリックしてください。 URL をクリックして、リポジトリの場所を手動で入力することもできます。

    [Clone a repository] メニュー内の [Location] タブ

    [Clone a repository] メニュー内の [Location] タブ

  3. クローンしたいリポジトリをリストから選択します。

    リポジトリリストのクローン

    リポジトリリストのクローン

  4. [選択] をクリックし、リポジトリを複製するローカル パスへ移動します。

    Chooseボタン

    Chooseボタン

  5. [複製] をクリックします。

    Cloneボタン

    Cloneボタン

Configuring Git to sync your fork with the original repository

When you fork a project in order to propose changes to the original repository, you can configure Git to pull changes from the original, or upstream, repository into the local clone of your fork.

  1. On your GitHub Enterprise Server instance, navigate to the octocat/Spoon-Knife repository.

  2. ファイルのリストの上にある [コード] をクリックしてください。 [コード] ボタン

  3. リポジトリの URL をコピーします。

    • HTTPS を使ってリポジトリをクローンするには、[HTTPS] の下の をクリックします。
    • 組織の SSH 認証局から発行された証明書を含む SSH キーを使用してリポジトリをクローンするには、 [SSH] の順にクリックします。
    • GitHub CLI を使ってリポジトリをクローンするには、 [GitHub CLI] の順にクリックします。 GitHub CLI でリポジトリをクローンするための URL をコピーするためのクリップボード アイコン
  4. [ターミナル][ターミナル][Git Bash] を開きます。

  5. Change directories to the location of the fork you cloned.

    • To go to your home directory, type just cd with no other text.
    • To list the files and folders in your current directory, type ls.
    • To go into one of your listed directories, type cd your_listed_directory.
    • To go up one directory, type cd ...
  6. Type git remote -v and press Enter. You will see the current configured remote repository for your fork.

    $ git remote -v
    > origin  https://ホスト名/YOUR_USERNAME/YOUR_FORK.git (fetch)
    > origin  https://ホスト名/YOUR_USERNAME/YOUR_FORK.git (push)
  7. Type git remote add upstream, and then paste the URL you copied in Step 3 and press Enter. It will look like this:

    $ git remote add upstream https://ホスト名/ORIGINAL_OWNER/Spoon-Knife.git
  8. To verify the new upstream repository you have specified for your fork, type git remote -v again. You should see the URL for your fork as origin, and the URL for the original repository as upstream.

    $ git remote -v
    > origin    https://ホスト名/YOUR_USERNAME/YOUR_FORK.git (fetch)
    > origin    https://ホスト名/YOUR_USERNAME/YOUR_FORK.git (push)
    > upstream  https://ホスト名/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (fetch)
    > upstream  https://ホスト名/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (push)

Now, you can keep your fork synced with the upstream repository with a few Git commands. For more information, see "Syncing a fork."

GitHub CLI の詳細については、「GitHub CLI について」を参照してください。

To configure a remote repository for the forked repository, use the --remote flag.

gh repo fork REPOSITORY --remote=true

To specify the remote repository's name, use the --remote-name flag.

gh repo fork REPOSITORY --remote-name "main-remote-repo"

Editing a fork

You can make any changes to a fork, including:

  • Creating branches: Branches allow you to build new features or test out ideas without putting your main project at risk.
  • Opening pull requests: If you are hoping to contribute back to the original repository, you can send a request to the original author to pull your fork into their repository by submitting a pull request.

Find another repository to fork

Fork a repository to start contributing to a project. You can fork a private or internal repository to your personal account or an organization on your GitHub Enterprise Server instance where you have repository creation permissions, if settings for the repository and your enterprise policies allow forking.

Next Steps

You have now forked a repository, practiced cloning your fork, and configured an upstream repository.

  • For more information about cloning the fork and syncing the changes in a forked repository from your computer, see "Set up Git."

  • You can also create a new repository where you can put all your projects and share the code on GitHub. プロジェクトのリポジトリを作成すると、コードを GitHub に格納できます。 これにより、他の開発者と共有するために選択できる作業のバックアップが提供されます。 詳細については、「リポジトリを作成する」を参照してください。"

  • GitHub の各リポジトリは、個人または組織が所有しています。 GitHub Enterprise Server に接続してフォローすることで、ユーザー、リポジトリ、および組織と対話できます。 詳細については、「交流する」を参照してください。

  • GitHub には素晴らしいサポート コミュニティがあり、助けを求め、世界中の人々と話すことができます。 GitHub Community で会話に参加してください。