Fork a Repo, Compare Code, and Create a Pull Request
So far, you've worked in a repository you own and you've been the only person working in it. You can only fully experience the power of a DVCS hosted repository by working with others. In this page, you work with a repository you don't own. You'll make a change to a code file, not just a README. You'll use Bitbucket's comparison features to compare your repository with the original.
The tutorial examples so far worked exclusively with Git repositories using
git commands. In this section, you'll work with a Mercurial repository. If you start working extensively in the host DVCS community, you'll most likely find yourself working with multiple DVC systems. You may even find yourself working with other hosted products, such as GitHub or Kiln. It is good experience to see the workflow you'd use in these types of situations.
The examples on this page are written for Mercurial using TortoiseHg on Microsoft Windows 7. If you want to work in Mac OSX or Linux, see the instructions on this page.
When you work with another user's public Bitbucket repository, typically you have read access to the code but not write access. This is where the concept of forking comes in. Here's how it works:
- Fork the repository to copy it to your own account.
- Clone the forked repository from Bitbucket to your local system.
- Make changes to the local repository.
- Push the changes to your forked repository on Bitbucket.
- Create a pull request from the original repository you forked to add the changes you made.
- Wait for the repository owner to accept or reject your changes.
If a repository owner accepts the pull request, Bitbucket merges your code changes into the original repository. It is recommended that you work with forks and pull requests, even if the repository owner gives you write access to a public repository. While a pull is part of the Git and Mercurial workflow, pull requests and forks are concepts used only by repository hosting services — like Bitbucket.
Step 1. Fork another user's repo
In this example you'll fork a public repository belonging to a user called
- Log into Bitbucket.
- Locate the Search field in the menu bar.
- Search for the
- Click on the search result to go to the repository.
- Click Fork.
The system displays the fork page.
- If your account is a member of a Bitbucket team, the page contains a field Owner. If you don't belong to a team, there is no Owner field; Continue to the next step.
- Change the Name for example, to
- Enter a Description that you think is appropriate.
- Uncheck Inherit repository user/group permissions.
There are several options for forking. For now, just leave all the remaining options at their defaults.
- Press Fork repository.
Step 2. Clone your fork
- Start the TortoiseHG Workbench.
- Choose View > Show Repository Registry.
- Choose File > Clone Repository.
- Enter location of your forked repository in the Source field
- Enter a destination on your system for your local repository, for example:
When you are done the dialog will look similar to the following:
- Press Clone.
The system clones the repository and displays it in the registry list.
Step 3. Make a change to the repository source
This repository contains a website which, as of this writing, has a an
editme.html file. Bitbucket allows you to host a website in a Mercurial repository. To see the hosted website, go to http://tutorials.bitbucket.org – you may encounter an Untrusted Connection message. Go ahead through to the site. You'll see that the site contains a single page that lists favorite quotes from "bitbuckians" which is just a writer-invented word for users of Bitbucket. Now, it is your turn to record your favorite comedic quote...or just a favorite quote. Do the following to contribute to this repository:
- Use Google or some other search engine to locate your favorite quote.
- In the TortoiseHG Workbench, select the
- Right-click to display the context menu.
- Choose Edit Local.
The file is an HTML file.
Go ahead and add a quote of your choosing. You can add an image link to your quote if you like, just place it above the <blockquote> tag.Here is a sample of what an addition will look like:
If you are not sure what to do, you can copy the example tags at the top of the file, paste them just below the last quote on the page, and modify them with your quote, as shown in the preceding example.
- Close and save the file.
- Refresh the Working Directory.
- Enter a commit message in the space provided.
- Press the Commit icon (check symbol) to commit your changes.
- Press the Push outgoing changes to selected URL icon.
The system prompts you to confirm your action.
- Press Yes.
The system pushes your changes to the forked repository.
Step 4 . Compare your fork to the original
While you were working on your fork, another Bitbucket user might have made updates to the original repository. At this point, you can check that and decide if you need to adjust your fork accordingly. Do the following to compare your changes with the repository:
- Log into Bitbucket and navigate to your
myquoteforkrepository. Forked repositories have a special widget that lets you compare your fork work to the original or to create a pull request.
- Click the Compare link on the left side of the page. The Compare section has a specialized view that is available only in forked repositories.
- Press the Compare button to compare your forked repository to the original repository.
- Click the Diff tab to compare changes from your fork to the original. If there are multiple commits, you see their cumulative changes by file in this section. Click the Side-by-side diff button to see changes displayed side-by-side. Or press the View file button to view the full file in Bitbucket.
- Switch back to the Compare tab to see the list of commits pushed from your local repository to the fork in Bitbucket. To see the contents of a specific commit in isolation, select a Commit link and the system takes you to the Commits page.
You can merge your fork into another repository — for example a local copy you may have of the original repository. If you merge locally, you can test your changes before making a pull request through Bitbucket.
Step 5. Create a pull request
If you haven't already done so, log into Bitbucket and navigate to your
myquotefork repository. Then, do the following:
- Press Create Pull Request.
The system displays the request form.
- Complete the form.
When you are done it will look something like this:
- Press Create pull request.
The system opens your latest request on the Pull Request page of the original repository. To see the list of all the pull requests against this repo, click the Pull Request tab.
Step 6. Learn what happens to your pull request
After you create a pull request, you can't delete it. Neither can the person that receives your request. The receiver either merges or declines your request. If you delete your fork after you make a request, the receiver can only decline your request because the repository to pull from is gone.
You have to wait for the repository owner to accept your pull request. When the original repository owner logs into Bitbucket, that user's newsfeed shows your pull request and your fork from a few days earlier, as shown in the following image.
When the repo owner clicks on your pull request, that user can Merge, Edit, or Decline (1) it. In addition to owners, anyone with access to the repository can Approve (2) the request, which means that the approver reviewed the changes in the pull request. The owner can also see any additional commits or activity (3) and how many files are in this pull request (4).
You'll get an email when your pull request is accepted or rejected. For now, continue to the next step.
That was intense. Maybe. Depends on your daily life. In the next section, you learn ways to be social on Bitbucket which includes adding users to your repository.
Was this helpful?
Thanks for your feedback!