@@ -95,8 +95,8 @@ Good pull requests - patches, improvements, new features - are a fantastic
95
95
help. They should remain focused in scope and avoid containing unrelated
96
96
commits.
97
97
98
- ** IMPORTANT** : By submitting a patch, you agree to allow the project owner to
99
- license your work under the same license as that used by the project.
98
+ ** IMPORTANT** : By submitting a patch, you agree that your work will be made
99
+ public forever and will be licensed under the license used by the project.
100
100
101
101
If you have any significant pull request in mind (e.g. implementing features,
102
102
refactoring code, porting to a different language), ** please ask first**
@@ -123,11 +123,16 @@ 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.
132
+
133
+ ** IMPORTANT** : Making changes in ` master ` is discouraged. You should always
134
+ keep your local ` master ` in sync with upstream ` master ` and make your
135
+ changes in topic branches.
131
136
132
137
``` bash
133
138
git checkout -b < topic-branch-name>
@@ -139,25 +144,35 @@ in order to craft an excellent pull request:
139
144
[ interactive rebase] ( https://help.github.com/articles/interactive-rebase )
140
145
feature to tidy up your commits before making them public.
141
146
142
- 5 . Locally merge (or rebase) the upstream development branch into your topic branch :
147
+ 5 . Push your topic branch up to your fork :
143
148
144
149
``` bash
145
- git pull [--rebase] upstream < dev -branch>
150
+ git push origin < topic -branch-name >
146
151
```
147
152
148
- 6 . Push your topic branch up to your fork:
153
+ 6 . [ Open a Pull Request] ( https://help.github.com/articles/using-pull-requests/ )
154
+ with a clear title and description.
155
+
156
+ 7 . If you haven't updated your pull request for a while, you should consider
157
+ rebasing on master and resolving any conflicts.
158
+
159
+ ** IMPORTANT** : _ Never ever_ merge upstream ` master ` into your branches. You
160
+ should always ` git rebase ` on ` master ` to bring your changes up to date when
161
+ necessary.
149
162
150
163
``` bash
151
- git push origin < topic-branch-name>
164
+ git checkout master
165
+ git pull upstream master
166
+ git checkout < your-topic-branch>
167
+ git rebase master
152
168
```
153
169
154
- 7 . [ Open a Pull Request] ( https://help.github.com/articles/using-pull-requests/ )
155
- with a clear title and description.
156
-
157
170
We have saved some excellent pull requests we have received in the past in case
158
171
you are looking for some examples:
159
172
160
173
* https://github.com/elixir-lang/elixir/pull/992
161
174
* https://github.com/elixir-lang/elixir/pull/1041
162
175
* https://github.com/elixir-lang/elixir/pull/1058
163
176
* https://github.com/elixir-lang/elixir/pull/1059
177
+
178
+ Thank you for your contributions!
0 commit comments