@@ -123,11 +123,12 @@ in order to craft an excellent pull request:
123
123
2 . If you cloned a while ago, get the latest changes from upstream:
124
124
125
125
``` bash
126
- git checkout < dev-branch >
127
- git pull upstream < dev-branch >
126
+ git checkout master
127
+ git pull upstream master
128
128
```
129
129
130
- 3 . Create a new topic branch (off master) to contain your feature, change, or fix:
130
+ 3 . Create a new topic branch (off of ` master ` ) to contain your feature, change,
131
+ or fix:
131
132
132
133
``` bash
133
134
git checkout -b < topic-branch-name>
@@ -139,25 +140,35 @@ in order to craft an excellent pull request:
139
140
[ interactive rebase] ( https://help.github.com/articles/interactive-rebase )
140
141
feature to tidy up your commits before making them public.
141
142
142
- 5 . Locally merge (or rebase) the upstream development branch into your topic branch :
143
+ 5 . Push your topic branch up to your fork :
143
144
144
145
``` bash
145
- git pull [--rebase] upstream < dev -branch>
146
+ git push origin < topic -branch-name >
146
147
```
147
148
148
- 6 . Push your topic branch up to your fork:
149
+ 6 . [ Open a Pull Request] ( https://help.github.com/articles/using-pull-requests/ )
150
+ with a clear title and description.
151
+
152
+ 7 . If you haven't updated your pull request for a while, you should consider
153
+ rebasing on master and resolving any conflicts.
154
+
155
+ ** IMPORTANT** : _ Never ever_ merge upstream ` master ` into your branches. You
156
+ should always ` git rebase ` on ` master ` to make your changes up to date when
157
+ necessary.
149
158
150
159
``` bash
151
- git push origin < topic-branch-name>
160
+ git checkout master
161
+ git pull upstream master
162
+ git checkout < your-topic-branch>
163
+ git rebase master
152
164
```
153
165
154
- 7 . [ Open a Pull Request] ( https://help.github.com/articles/using-pull-requests/ )
155
- with a clear title and description.
156
-
157
166
We have saved some excellent pull requests we have received in the past in case
158
167
you are looking for some examples:
159
168
160
169
* https://github.com/elixir-lang/elixir/pull/992
161
170
* https://github.com/elixir-lang/elixir/pull/1041
162
171
* https://github.com/elixir-lang/elixir/pull/1058
163
172
* https://github.com/elixir-lang/elixir/pull/1059
173
+
174
+ Thanks for your contributions!
0 commit comments