Fork A Repo – User Documentation
GitHub Help
Bootcamp / Fork A Repo
A fork is a copy of a repository. Forking a repository permits you to loosely experiment with switches without affecting the original project.
Most commonly, forks are used to either propose switches to someone else’s project or to use someone else’s project as a kicking off point for your own idea.
Propose switches to someone else’s project
A fine example of using forks to propose switches is for bug fixes. 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 possessor.
If the project proprietor likes your work, they might pull your fix into the original repository!
Use someone else’s project as a kicking off point for your own idea.
At the heart of open source is the idea that by sharing code, we can make better, more reliable software.
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 collective with others.
For more information on open source, specifically how to create and grow an open source project, we’ve created Open Source Guides that will help you foster a healthy open source community by recommending best practices for creating and maintaining repositories for your open source project.
Fork an example repository
Forking a repository is a plain two-step process. We’ve created a repository for you to practice with!
That’s it! Now, you have a fork of the original octocat/Spoon-Knife repository.
Keep your fork synced
You might fork a project in order to propose switches 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 instruction line. You can practice setting the upstream repository using the same octocat/Spoon-Knife repository you just forked!
Step 1: Set Up Git
Step Two: Create a local clone of your fork
Right now, you have a fork of the Spoon-Knife repository, but you don’t have the files in that repository on your computer. Let’s create a clone of your fork locally on your computer.
- On GitHub, navigate to your fork of the Spoon-Knife repository.
- Under the repository name, click Clone or download.
In the Clone with HTTPs section, click to copy the clone URL for the repository.
Open Terminal Terminal Git Bash .
Type git clone , and then paste the URL you copied in Step Two. It will look like this, with your GitHub username instead of YOUR-USERNAME :
Press Inject. Your local clone will be created.
Now, you have a local copy of your fork of the Spoon-Knife repository!
Step Trio: Configure Git to sync your fork with the original Spoon-Knife repository
When you fork a project in order to propose switches to the original repository, you can configure Git to pull switches from the original, or upstream, repository into the local clone of your fork.
- On GitHub, navigate to the octocat/Spoon-Knife repository.
- Under the repository name, click Clone or download.
In the Clone with HTTPs section, click to copy the clone URL for the repository.
Open Terminal Terminal Git Bash .
Switch directories to the location of the fork you cloned in Step Two: Create a local clone of your fork.
- 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 .. .
Type git remote -v and press Come in. You’ll see the current configured remote repository for your fork.
Type git remote add upstream , and then paste the URL you copied in Step two and press Inject. It will look like this:
To verify the fresh 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 .
Now, you can keep your fork synced with the upstream repository with a few Git directions. For more information, see “Syncing a fork.”
Next Steps
The sky’s the limit with the switches you can make to a fork, including:
- Creating branches:Branches permit you to build fresh 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
Every public repository can be forked, so find another project you’re interested in and get forking!
Explore GitHub is a superb place to find projects that pique your interest. Visit that page often to see what’s fresh and cool.
Feast
You have now forked a repository, practiced cloning your fork, and configured an upstream repository. What do you want to do next?
