Skip to content

CONTRIBUTING update for the github squash button. #4087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fjy merged 1 commit into from
Mar 21, 2017
Merged

CONTRIBUTING update for the github squash button. #4087

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,13 @@ When submitting a pull request (PR), please use the following guidelines:
git commit -a
```

1. Periodically rebase your changes
1. Before submitting a pull request, periodically rebase your changes

```
git pull --rebase
```

1. When done, combine ("squash") related commits into a single one
1. Before submitting a pull request, combine ("squash") related commits into a single one

```
git rebase -i upstream/master
Expand Down Expand Up @@ -96,24 +96,24 @@ When submitting a pull request (PR), please use the following guidelines:

1. Addressing code review comments

Repeat steps 5. through 7. to address any code review comments and
rebase your changes if necessary.

Push your updated changes to update the pull request
Address code review comments by committing changes and pushing them to your feature
branch.

```
git push origin [--force] feature-xxx
git push origin feature-xxx
```

`--force` may be necessary to overwrite your existing pull request in case your
commit history was changed when performing the rebase.

Note: Be careful when using `--force` since you may lose data if you are not careful.
If your pull request shows conflicts with master, merge master into your feature branch
and resolve the conflicts. After resolving conflicts, push your branch again.

```
git push origin --force feature-xxx
git merge master
```

Avoid rebasing and force pushes after submitting a pull request, since these make it
difficult for reviewers to see what you've changed in response to their reviews. The Druid
committer that merges your change will rebase and squash it into a single commit before
committing it to master.

# FAQ

Expand Down