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 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've 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 GitHub, 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.

Para mais informações sobre código aberto, especificamente como criar e crescer um projeto de código aberto, Criamos Guias em Código Aberto que ajudarão você a fomentar uma comunidade de código aberto saudável, recomendando as melhores práticas para a criação e manutenção de repositórios para seu projeto de código aberto. Você também pode participar de um curso gratuito GitHub Learning Lab sobre a manutenção de comunidades de código aberto.

Prerequisties

If you haven't yet, you should first set up Git. Don't forget to set up authentication to GitHub 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 GitHub, navigate to the octocat/Spoon-Knife repository.
  2. In the top-right corner of the page, click Fork. Fork button

To download or find more information about GitHub CLI, see the GitHub CLI feature page.

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 don't have the files in that repository locally your computer.

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

  2. Acima da lista de arquivos, clique em código. Botão de "Código"

  3. Para clonar o repositório usando HTTPS, em "Clonar com HTTPS", clique em . Para clonar o repositório usando uma chave SSH, incluindo um certificado emitido pela autoridade certificada e SSH da sua organização, clique em Usar SSH e, em seguida, clique em . Para clonar um repositório usando GitHub CLI, clique em Usar GitHub CLI e, em seguida, clique em . O ícone da área de transferência para copiar a URL para clonar um repositório

    O ícone da área de transferência para copiar a URL para clonar um repositório com o CLI do GitHub

  4. Abra TerminalTerminalGit Bash.

  5. Altere o diretório de trabalho atual para o local em que deseja ter o diretório clonado.

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

    $ git clone https://github.com/YOUR-USERNAME/Spoon-Knife
  7. Press Enter. Your local clone will be created.

    $ git clone https://github.com/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.

To download or find more information about GitHub CLI, see the GitHub CLI feature page.

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

gh repo fork repository --clone=true
  1. No menu File (Arquivo), clique em Clone Repository (Clonar repositório).

    Opção de menu Clone (Clonar) no app Mac

    Opção de menu Clone (Clonar) no app Windows

  2. Clique na aba que corresponde à localização do repositório que você deseja clonar. Você também pode clicar URL para inserir manualmente o local do repositório.

    Guias Location (Local) no menu Clone a repository (Clonar um repositório)

    Guias Location (Local) no menu Clone a repository (Clonar um repositório)

  3. Escolha o repositório que você quer clonar na lista.

    Clonar uma lista de repositórios

    Clonar uma lista de repositórios

  4. Clique em Escolher... e acesse um caminho local onde você deseja clonar o repositório.

    Botão Choose (Escolher)

    Botão Choose (Escolher)

  5. Clique em Clone (Clonar).

    Botão Clone (Clonar)

    Botão Clone (Clonar)

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 GitHub, navigate to the octocat/Spoon-Knife repository.

  2. Acima da lista de arquivos, clique em código. Botão de "Código"

  3. Para clonar o repositório usando HTTPS, em "Clonar com HTTPS", clique em . Para clonar o repositório usando uma chave SSH, incluindo um certificado emitido pela autoridade certificada e SSH da sua organização, clique em Usar SSH e, em seguida, clique em . Para clonar um repositório usando GitHub CLI, clique em Usar GitHub CLI e, em seguida, clique em . O ícone da área de transferência para copiar a URL para clonar um repositório

    O ícone da área de transferência para copiar a URL para clonar um repositório com o CLI do GitHub

  4. Abra TerminalTerminalGit 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'll see the current configured remote repository for your fork.

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

    $ git remote add upstream https://github.com/octocat/Spoon-Knife.git
  8. To verify the new upstream repository you've 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://github.com/YOUR_USERNAME/YOUR_FORK.git (fetch)
    > origin    https://github.com/YOUR_USERNAME/YOUR_FORK.git (push)
    > upstream  https://github.com/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (fetch)
    > upstream  https://github.com/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."

To download or find more information about GitHub CLI, see the GitHub CLI feature page.

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"

Next steps

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. Você pode criar um fork de um repositório para a sua conta de usuário ou para qualquer organização onde você tenha permissões de criação de repositório. Para obter mais informações, consulte "Níveis de permissão para uma organização".

Se você tem acesso a um repositório privado e o proprietário permite a bifurcação, você pode criar um fork do repositório para a conta do usuário ou para qualquer organização em GitHub Team onde você tem permissões de criação de repositório. Você não pode criar um repositório privado para uma organização usando GitHub Free. Para obter mais informações, consulte "produtos do GitHub."

You can browse Explore to find projects and start contributing to open source repositories. For more information, see "Finding ways to contribute to open source on GitHub."

Celebrate

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. For more information see, "Create a repository."

Each repository in GitHub is owned by a person or an organization. You can interact with the people, repositories, and organizations by connecting and following them on GitHub. For more information see "Be social."

Conecte-se com pessoas no mundo todo em Suporte à Comunidade GitHub

Esse documento ajudou você?Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.