123 lines
8.0 KiB
Markdown
123 lines
8.0 KiB
Markdown
---
|
||
title: Contributing to a project
|
||
shortTitle: Contribute to a project
|
||
intro: Learn how to contribute to a project through forking.
|
||
permissions: '{% data reusables.enterprise-accounts.emu-permission-fork %}'
|
||
versions:
|
||
fpt: '*'
|
||
ghes: '*'
|
||
ghec: '*'
|
||
topics:
|
||
- Pull requests
|
||
- Forks
|
||
- GitHub
|
||
- Open Source
|
||
redirect_from:
|
||
- /get-started/quickstart/contributing-to-projects
|
||
---
|
||
|
||
Contributing to a project on {% data variables.product.github %} is an essential skill for developers and collaborators working together to achieve shared goals. Whether you're fixing bugs, adding features, or improving documentation, the process of contributing ensures structured and efficient collaboration.
|
||
|
||
By following the {% data variables.product.github %} flow of forking repositories, creating branches, and submitting pull requests, you can propose changes to a project and get feedback without disrupting other people's work.
|
||
|
||
This guide provides instructions on contributing to a project using the GitHub UI and the command line. For more information on contributing with GitHub Desktop, see [AUTOTITLE](/desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop). For the same with GitHub CLI (Command Line Interface), see [AUTOTITLE](/github-cli/github-cli/quickstart).
|
||
|
||
## 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](/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo).
|
||
|
||
## Creating your own copy of a project
|
||
|
||
This tutorial uses [the Spoon-Knife project](https://github.com/octocat/Spoon-Knife), 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.
|
||
1. In the top-right corner of the page, click **Fork**.
|
||
|
||
|
||
1. 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](/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork#syncing-a-fork-branch-from-the-web-ui).
|
||
1. 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.
|
||
1. Optionally, in the "Description" field, type a description of your fork.
|
||
1. 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.
|
||
1. 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](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository).
|
||
|
||
## 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 %}.
|
||
|
||
1. On {% data variables.product.github %}, navigate to **your fork** of the Spoon-Knife repository.
|
||
{% data reusables.repositories.copy-clone-url %}
|
||
1. On Mac or Linux, open Terminal. On Windows, open Git Bash.
|
||
{% data reusables.command_line.change-current-directory-clone %}
|
||
1. 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`:
|
||
|
||
```shell
|
||
git clone https://{% data variables.product.product_url %}/YOUR-USERNAME/Spoon-Knife
|
||
```
|
||
|
||
1. Press **Enter**. Your local clone will be created.
|
||
|
||
```shell
|
||
$ 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.
|
||
```
|
||
|
||
## 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](/get-started/using-github/github-flow#following-github-flow).
|
||
|
||
```shell
|
||
git branch BRANCH-NAME
|
||
git checkout BRANCH-NAME
|
||
```
|
||
|
||
## 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 %}](https://code.visualstudio.com). 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.
|
||
|
||
```shell
|
||
git add .
|
||
git commit -m "a short description of the change"
|
||
```
|
||
|
||
When you stage and commit files, you essentially tell Git, "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.
|
||
|
||
```shell
|
||
git push
|
||
```
|
||
|
||
## Making a pull request
|
||
|
||
Creating a pull request is the final step in producing a fork of someone else's project. When you've made a beneficial change and want to propose it to the original repository, you'll create a pull request for a maintainer to review.
|
||
|
||
To do so, navigate 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**.
|
||
|
||
{% 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](/get-started/exploring-projects-on-github/using-github-copilot-to-explore-projects).{% endif %}
|