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 tu instancia de GitHub Enterprise Server, 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 obtener más información acerca del código abierto, específicamente sobre cómo crear y hacer crecer un proyecto de código abierto, hemos creado las Guías de Código Abierto que te ayudarán fomentar una comunidad saludable mediante la recomendación de mejores prácticas para crear y mantener repositorios para tus proyectos de código abierto. También puedes tomar un curso gratuito de Laboratorio de aprendizaje de GitHub sobre cómo mantener comunidades de código abierto.
Prerequisites
If you haven't yet, you should first set up Git. Don't forget to set up authentication to tu instancia de GitHub Enterprise Server 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.
- On tu instancia de GitHub Enterprise Server, navigate to the octocat/Spoon-Knife repository.
- In the top-right corner of the page, click Fork.
Para aprender más sobre el CLI de GitHub, consulta la sección "Acerca del CLI de GitHub".
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 on your computer.
-
On tu instancia de GitHub Enterprise Server, navigate to your fork of the Spoon-Knife repository.
-
Sobre la lista de archivos, da clic en Código.
-
Para clonar el repositorio utilizando HTTPS, debajo de "Clonar con HTTPS", da clic en . Para clonar el repositorio utilizando una llave SSH, incluyendo un certificado emitido por la autoridad de certificados SSH de tu organización, haz clic en Utilizar SSH y luego en . Para clonar un repositorio utilizando el CLI de GitHub, haz clic en Utilizar el CLI de GitHub y luego en .
-
Abre la TerminalTerminalGit Bash.
-
Cambia el directorio de trabajo actual a la ubicación en donde quieres clonar el directorio.
-
Type
git clone
, and then paste the URL you copied earlier. It will look like this, with your GitHub Enterprise Server username instead ofYOUR-USERNAME
:$ git clone https://nombre de host/YOUR-USERNAME/Spoon-Knife
-
Press Enter. Your local clone will be created.
$ git clone https://nombre de host/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.
Para aprender más sobre el CLI de GitHub, consulta la sección "Acerca del CLI de GitHub".
To create a clone of your fork, use the --clone
flag.
gh repo fork repository --clone=true
-
En el menú File (Archivo) haz clic en Clone Repository (Clonar repositorio).
-
Haz clic en la pestaña que corresponde a la ubicación del repositorio que deseas clonar. También puedes hacer clic en URL para introducir manualmente la ubicación del repositorio.
-
Elige dentro de la lista el repositorio que deseas clonar.
-
Haz clic en Elegir... y navega a la ruta local en donde quieres clonar el repositorio.
-
Haz clic en 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.
-
On tu instancia de GitHub Enterprise Server, navigate to the octocat/Spoon-Knife repository.
-
Sobre la lista de archivos, da clic en Código.
-
Para clonar el repositorio utilizando HTTPS, debajo de "Clonar con HTTPS", da clic en . Para clonar el repositorio utilizando una llave SSH, incluyendo un certificado emitido por la autoridad de certificados SSH de tu organización, haz clic en Utilizar SSH y luego en . Para clonar un repositorio utilizando el CLI de GitHub, haz clic en Utilizar el CLI de GitHub y luego en .
-
Abre la TerminalTerminalGit Bash.
-
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 ..
.
- To go to your home directory, type just
-
Type
git remote -v
and press Enter. You'll see the current configured remote repository for your fork.$ git remote -v > origin https://nombre de host/YOUR_USERNAME/YOUR_FORK.git (fetch) > origin https://nombre de host/YOUR_USERNAME/YOUR_FORK.git (push)
-
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://nombre de host/octocat/Spoon-Knife.git
-
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 asorigin
, and the URL for the original repository asupstream
.$ git remote -v > origin https://nombre de host/YOUR_USERNAME/YOUR_FORK.git (fetch) > origin https://nombre de host/YOUR_USERNAME/YOUR_FORK.git (push) > upstream https://nombre de host/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (fetch) > upstream https://nombre de host/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."
Para aprender más sobre el CLI de GitHub, consulta la sección "Acerca del CLI de GitHub".
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. Puedes bifurcar un repositorio hacia tu cuenta de usuario o hacia cualquier organización en donde tengas permisos de creación de repositorios. Para obtener más información, consulta la sección "Roles en una organización".
Si tienes acceso a un repositorio privado y el propietario permite las bifurcaciones, puedes bifurcar el repositorio hacia tu cuenta de usuario o hacia cualquier organización en tu instancia de GitHub Enterprise Server en donde tengas permisos de creación de repositorios.
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 Enterprise Server is owned by a person or an organization. You can interact with the people, repositories, and organizations by connecting and following them on GitHub Enterprise Server. For more information see "Be social."
GitHub tiene una excelente comunidad de soporte en donde puedes pedir ayuda y hablar con las personas de todo el mundo. Únete a la conversación en la Comunidad de soporte de GitHub.