You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
20
+
21
+
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.
22
+
23
+
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).
24
+
19
25
## About forking
20
26
21
27
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.
@@ -50,11 +56,9 @@ You've successfully forked the Spoon-Knife repository, but so far, it only exist
50
56
51
57
You can clone your fork with the command line, {% data variables.product.prodname_cli %}, or {% data variables.product.prodname_desktop %}.
52
58
53
-
{% webui %}
54
-
55
59
1. On {% data variables.product.github %}, navigate to **your fork** of the Spoon-Knife repository.
56
60
{% data reusables.repositories.copy-clone-url %}
57
-
{% data reusables.command_line.open_the_multi_os_terminal %}
61
+
1. On Mac or Linux, open Terminal. On Windows, open Git Bash.
58
62
{% data reusables.command_line.change-current-directory-clone %}
59
63
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`:
60
64
@@ -73,133 +77,44 @@ You can clone your fork with the command line, {% data variables.product.prodnam
73
77
> Unpacking objects: 100% (10/10), done.
74
78
```
75
79
76
-
{% endwebui %}
77
-
78
-
{% cli %}
79
-
80
-
{% data reusables.cli.cli-learn-more %}
81
-
82
-
To create a clone of your fork, use the `--clone` flag.
83
-
84
-
```shell
85
-
gh repo fork REPOSITORY --clone=true
86
-
```
87
-
88
-
{% endcli %}
89
-
90
-
{% desktop %}
91
-
92
-
{% data reusables.desktop.choose-clone-repository %}
93
-
{% data reusables.desktop.cloning-location-tab %}
94
-
{% data reusables.desktop.cloning-repository-list %}
95
-
{% data reusables.desktop.choose-local-path %}
96
-
{% data reusables.desktop.click-clone %}
97
-
98
-
{% enddesktop %}
99
-
100
80
## Creating a branch to work on
101
81
102
82
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).
103
83
104
-
{% webui %}
105
-
106
84
```shell
107
85
git branch BRANCH-NAME
108
86
git checkout BRANCH-NAME
109
87
```
110
88
111
-
{% endwebui %}
112
-
113
-
{% cli %}
114
-
115
-
```shell
116
-
git branch BRANCH-NAME
117
-
git checkout BRANCH-NAME
118
-
```
119
-
120
-
{% endcli %}
121
-
122
-
{% desktop %}
123
-
124
-
For more information about how to create and manage branches in {% data variables.product.prodname_desktop %}, see [AUTOTITLE](/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop).
125
-
126
-
{% enddesktop %}
127
-
128
89
## Making and pushing changes
129
90
130
91
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.
131
92
132
93
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.
133
94
134
-
{% webui %}
135
-
136
-
```shell
137
-
git add .
138
-
git commit -m "a short description of the change"
139
-
```
140
-
141
-
{% endwebui %}
142
-
143
-
{% cli %}
144
-
145
95
```shell
146
96
git add .
147
97
git commit -m "a short description of the change"
148
98
```
149
99
150
-
{% endcli %}
151
-
152
-
{% desktop %}
153
-
154
-
For more information about how to stage and commit changes in {% data variables.product.prodname_desktop %}, see [AUTOTITLE](/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop#selecting-changes-to-include-in-a-commit).
155
-
156
-
{% enddesktop %}
157
-
158
-
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.
100
+
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.
159
101
160
102
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.
161
103
162
-
{% webui %}
163
-
164
104
```shell
165
105
git push
166
106
```
167
107
168
-
{% endwebui %}
169
-
170
-
{% cli %}
171
-
172
-
```shell
173
-
git push
174
-
```
175
-
176
-
{% endcli %}
177
-
178
-
{% desktop %}
179
-
180
-
For more information about how to push changes in {% data variables.product.prodname_desktop %}, see [AUTOTITLE](/desktop/making-changes-in-a-branch/pushing-changes-to-github-from-github-desktop).
181
-
182
-
{% enddesktop %}
183
-
184
108
## Making a pull request
185
109
186
-
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.
110
+
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.
187
111
188
-
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**.
112
+
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**.
189
113
190
114
{% 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**.
191
115
192
116
{% 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**.
193
117
194
-
## Managing feedback
195
-
196
-
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.
197
-
198
-
## Finding projects
199
-
200
-
You've successfully forked and contributed back to a repository. Go forth, and
201
-
contribute some more!{% ifversion fpt %} For more information, see [AUTOTITLE](/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github).{% endif %}
0 commit comments