contributing-to-a-project.md

title	shortTitle	intro	permissions	versions	topics	redirect_from
Contributing to a project	Contribute to a project	Learn how to contribute to a project through forking.	{% data reusables.enterprise-accounts.emu-permission-fork %}	fpt ghes ghec * * *	Pull requests Forks GitHub Open Source	/get-started/quickstart/contributing-to-projects

About forking

If you want to contribute to someone else's project but don’t have permission to make changes directly, you can create your own copy of the project, make updates, and then suggest those updates for inclusion in the main project. This process is often called a "fork and pull request" workflow.

When you create your own copy (or "fork") of a project, it’s like making a new workspace that shares code with the original project. This is useful for open-source projects or anytime you don’t have write access to the original project.

Once you’ve made your changes in your copy, you can submit them as a pull request, which is a way to propose changes back to the main project. For more information, see AUTOTITLE.

Creating your own copy of a project

This tutorial uses the Spoon-Knife project, a test repository that's hosted on {% data variables.product.prodname_dotcom %} that lets you test the fork and pull request workflow.

1. Navigate to the Spoon-Knife project at https://github.com/octocat/Spoon-Knife.

2. In the top-right corner of the page, click Fork.

   

3. Under "Owner," select the dropdown menu and click an owner for the forked repository.

   [!NOTE] If your username is grayed out, it's because the fork already exists. Instead, you should bring your existing fork up to date. For more information, see AUTOTITLE.

4. By default, forks are named the same as their upstream repositories. Optionally, to further distinguish your fork, in the "Repository name" field, type a name.

5. Optionally, in the "Description" field, type a description of your fork.

6. Optionally, select Copy the DEFAULT branch only.

   For many forking scenarios, such as contributing to open-source projects, you only need to copy the default branch. If you do not select this option, all branches will be copied into the new fork.

7. Click Create fork.

Note

If you want to copy additional branches from the upstream repository, you can do so from the Branches page. For more information, see AUTOTITLE.

Cloning a fork to your computer

You've successfully forked the Spoon-Knife repository, but so far, it only exists on {% data variables.product.github %}. To be able to work on the project, you will need to clone it to your computer.

You can clone your fork with the command line, {% data variables.product.prodname_cli %}, or {% data variables.product.prodname_desktop %}.

{% webui %}

1. On {% data variables.product.github %}, navigate to your fork of the Spoon-Knife repository. {% data reusables.repositories.copy-clone-url %} {% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.command_line.change-current-directory-clone %}

2. Type git clone, and then paste the URL you copied earlier. It will look like this, with your {% data variables.product.github %} username instead of YOUR-USERNAME:

   git clone https://{% data variables.product.product_url %}/YOUR-USERNAME/Spoon-Knife

3. Press Enter. Your local clone will be created.

   $ git clone https://{% data variables.product.product_url %}/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.

{% endwebui %}

{% cli %}

{% data reusables.cli.cli-learn-more %}

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

gh repo fork REPOSITORY --clone=true

{% endcli %}

{% desktop %}

{% data reusables.desktop.choose-clone-repository %} {% data reusables.desktop.cloning-location-tab %} {% data reusables.desktop.cloning-repository-list %} {% data reusables.desktop.choose-local-path %} {% data reusables.desktop.click-clone %}

{% enddesktop %}

Creating a branch to work on

Before making changes to the project, you should create a new branch and check it out. By keeping changes in their own branch, you follow {% data variables.product.github %} flow and ensure that it will be easier to contribute to the same project again in the future. See AUTOTITLE.

{% webui %}

git branch BRANCH-NAME
git checkout BRANCH-NAME

{% endwebui %}

{% cli %}

git branch BRANCH-NAME
git checkout BRANCH-NAME

{% endcli %}

{% desktop %}

For more information about how to create and manage branches in {% data variables.product.prodname_desktop %}, see AUTOTITLE.

{% enddesktop %}

Making and pushing changes

Go ahead and make a few changes to the project using your favorite text editor, like {% data variables.product.prodname_vscode %}. You could, for example, change the text in index.html to add your {% data variables.product.github %} username.

When you're ready to submit your changes, stage and commit your changes. git add . tells Git that you want to include all of your changes in the next commit. git commit takes a snapshot of those changes.

{% webui %}

git add .
git commit -m "a short description of the change"

{% endwebui %}

{% cli %}

git add .
git commit -m "a short description of the change"

{% endcli %}

{% desktop %}

For more information about how to stage and commit changes in {% data variables.product.prodname_desktop %}, see AUTOTITLE.

{% enddesktop %}

When you stage and commit files, you essentially tell Git, "Okay, take a snapshot of my changes!" You can continue to make more changes, and take more commit snapshots.

Right now, your changes only exist locally. When you're ready to push your changes up to {% data variables.product.github %}, push your changes to the remote.

{% webui %}

git push

{% endwebui %}

{% cli %}

git push

{% endcli %}

{% desktop %}

For more information about how to push changes in {% data variables.product.prodname_desktop %}, see AUTOTITLE.

{% enddesktop %}

Making a pull request

At last, you're ready to propose changes into the main project! This is the final step in producing a fork of someone else's project, and arguably the most important. If you've made a change that you feel would benefit the community as a whole, you should definitely consider contributing back.

To do so, head on over to the repository on {% data variables.product.github %} where your project lives. For this example, it would be at https://github.com/<your_username>/Spoon-Knife. You'll see a banner indicating that your branch is one commit ahead of octocat:main. Click Contribute and then Open a pull request.

{% data variables.product.github %} will bring you to a page that shows the differences between your fork and the octocat/Spoon-Knife repository. Click Create pull request.

{% data variables.product.github %} will bring you to a page where you can enter a title and a description of your changes. It's important to provide as much useful information and a rationale for why you're making this pull request in the first place. The project owner needs to be able to determine whether your change is as useful to everyone as you think it is. Finally, click Create pull request.

Managing feedback

Pull requests are an area for discussion. Don't be offended if the project owner rejects your pull request, or asks for more information on why it's been made. Even if the project owner chooses not to merge your pull request, your changes still exist in your fork. It could be that someone else will find your fork much more valuable than the original project.

Finding projects

You've successfully forked and contributed back to a repository. Go forth, and contribute some more!{% ifversion fpt %} For more information, see AUTOTITLE.{% endif %}

{% ifversion copilot %}

Familiarizing yourself with a project

If you're new to a project, you can use {% data variables.product.prodname_copilot_short %} to help you understand the purpose of the repository, examine files, and dive into specific lines of code. See AUTOTITLE.{% endif %}