Skip to content

Commit f37e5c6

Browse files
committed
Update pull request creation guidelines
1 parent 96a4319 commit f37e5c6

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -123,11 +123,12 @@ in order to craft an excellent pull request:
123123
2. If you cloned a while ago, get the latest changes from upstream:
124124

125125
```bash
126-
git checkout <dev-branch>
127-
git pull upstream <dev-branch>
126+
git checkout master
127+
git pull upstream master
128128
```
129129

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:
131132

132133
```bash
133134
git checkout -b <topic-branch-name>
@@ -139,25 +140,35 @@ in order to craft an excellent pull request:
139140
[interactive rebase](https://help.github.com/articles/interactive-rebase)
140141
feature to tidy up your commits before making them public.
141142

142-
5. Locally merge (or rebase) the upstream development branch into your topic branch:
143+
5. Push your topic branch up to your fork:
143144

144145
```bash
145-
git pull [--rebase] upstream <dev-branch>
146+
git push origin <topic-branch-name>
146147
```
147148

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.
149158

150159
```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
152164
```
153165

154-
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
155-
with a clear title and description.
156-
157166
We have saved some excellent pull requests we have received in the past in case
158167
you are looking for some examples:
159168

160169
* https://github.com/elixir-lang/elixir/pull/992
161170
* https://github.com/elixir-lang/elixir/pull/1041
162171
* https://github.com/elixir-lang/elixir/pull/1058
163172
* https://github.com/elixir-lang/elixir/pull/1059
173+
174+
Thanks for your contributions!

0 commit comments

Comments
 (0)