Skip to content

CONTRIBUTING update for the github squash button.#4087

Merged
fjy merged 1 commit intoapache:masterfrom
gianm:contributing
Mar 21, 2017
Merged

CONTRIBUTING update for the github squash button.#4087
fjy merged 1 commit intoapache:masterfrom
gianm:contributing

Conversation

@gianm
Copy link
Copy Markdown
Contributor

@gianm gianm commented Mar 21, 2017

Some changes to the contributing guidelines to make pull requests
easier to review. The existing guidelines were written back when github
didn't have a squash-and-rebase feature, so people had to squash
their own commits. Now it's easier if they don't.

Some changes to the contributing guidelines to make pull requests
easier to review.
@fjy
Copy link
Copy Markdown
Contributor

fjy commented Mar 21, 2017

👍

@fjy fjy merged commit 4f7f3e3 into apache:master Mar 21, 2017
@gianm gianm deleted the contributing branch March 21, 2017 17:13
@leventov
Copy link
Copy Markdown
Member

leventov commented Mar 21, 2017

Another problem is that CONTRIBUTING.md suggests to do rebases, instead of merging master into feature branch. Rebases are very inconvenient for reviewing, because reviewer cannot separately look at changes that he hasn't yet reviewed, and also older comments to the code are lost.

Before Github used to display full diffs of merge commits so it was also inconvenient for reviewing. But now Github always displays diff between the feature branch and the current master, so this problem is gone.

@gianm
Copy link
Copy Markdown
Contributor Author

gianm commented Mar 21, 2017

I think the changes address that concern, it now says:

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants