doc: Explain rebase policy in CONTRIBUTING.md #18283

MarcoFalke commented at 5:28 PM on March 6, 2020: member

No description provided.

in CONTRIBUTING.md:165 in fa733bbd78 outdated

 160 | +[/contrib/verify-commits](/contrib/verify-commits) checks that.
 161 | +
 162 | +After a rebase, reviewers are encouraged to sign off on the force push. This should be relatively straightforward with
 163 | +the `git range-diff` tool explained in the [productivity
 164 | +notes](/doc/productivity.md#diff-the-diffs-with-git-range-diff). To avoid needless review churn, maintainers will
 165 | +generally merge pull request that received the most review attention first.

jonatack commented at 5:32 PM on March 6, 2020:

s/request/requests/

MarcoFalke commented at 7:00 PM on March 6, 2020:

Thanks, done!

jonatack commented at 5:41 PM on March 6, 2020: member

ACK modulo typo

fanquake added the label Docs on Mar 6, 2020

MarcoFalke force-pushed on Mar 6, 2020

sanjaykdragon commented at 7:08 PM on March 6, 2020: contributor

Unrelated, but what is the point of squashing commits?

MarcoFalke force-pushed on Mar 6, 2020

MarcoFalke commented at 7:16 PM on March 6, 2020: member

@sanjaykdragon Explained in the latest force push

fanquake commented at 10:33 PM on March 6, 2020: member

Is this an alternative to #17940?

MarcoFalke commented at 2:50 PM on March 7, 2020: member

@fanquake Wasn't planned, but I see that they are mostly overlapping.

emilengler commented at 2:39 PM on March 8, 2020: contributor

ACK faecaf82233e37be876f76356e9dc69a03c2c340 Good to have this for new contributors who are not that familiar with git and our git policy

in CONTRIBUTING.md:124 in faecaf8223 outdated

 123 | ----------------------------
 124 | -If your pull request is accepted for merging, you may be asked by a maintainer
 125 | -to squash and or [rebase](https://git-scm.com/docs/git-rebase) your commits
 126 | +### Squashing Commits
 127 | +
 128 | +If your pull request contains fixup commits (commits that change the same line of code repeatetly) or too fine-grained

hebasto commented at 9:26 AM on March 11, 2020:

typo? s/repeatetly/repeatedly/

hebasto commented at 9:27 AM on March 11, 2020: member

ACK faecaf82233e37be876f76356e9dc69a03c2c340 modulo typo.

doc: Explain rebase/squash policy in CONTRIBUTING.md fa1244783c

in CONTRIBUTING.md:120 in faecaf8223 outdated

 118 | @@ -119,10 +119,10 @@ to your fork until you have satisfied all feedback.
 119 |  
 120 |  Note: Code review is a burdensome but important part of the development process, and as such, certain types of pull requests are rejected. In general, if the **improvements** do not warrant the **review effort** required, the PR has a high chance of being rejected. It is up to the PR author to convince the reviewers that the changes warrant the review effort, and if reviewers are "Concept NAK'ing" the PR, the author may need to present arguments and/or do research backing their suggested changes.

jonatack commented at 9:36 AM on March 11, 2020:

while fixing up the typo (repeatetly), perhaps also:

s/"Concept NAK'ing"/"Concept NACK" on/

MarcoFalke commented at 11:52 AM on March 11, 2020: member

Fixed typos as requested by @jonatack and @hebasto

MarcoFalke force-pushed on Mar 11, 2020

hebasto commented at 11:58 AM on March 11, 2020: member

re-ACK fa1244783ccb4798af4906ac6be5a38df241fa38, typos fixed.

in CONTRIBUTING.md:158 in fa1244783c

 153 | +
 154 | +When a pull request conflicts with the target branch, you may be asked to rebase it on top of the current target branch.
 155 | +The `git rebase` command will take care of rebuilding your commits on top of the new base.
 156 | +
 157 | +This project aims to have a clean git history, where code changes are only made in non-merge commits. This simplifies
 158 | +auditability because merge commits can be assumed to not contain arbitrary code changes. Merge commits should be signed,

jonatack commented at 12:03 PM on March 11, 2020:

maybe s/auditability/auditing/ but doesn't really matter

jonatack commented at 12:05 PM on March 11, 2020: member

ACK

laanwj commented at 3:01 PM on March 11, 2020: member

ACK fa1244783ccb4798af4906ac6be5a38df241fa38

laanwj merged this on Mar 11, 2020

laanwj closed this on Mar 11, 2020

MarcoFalke deleted the branch on Mar 11, 2020

PastaPastaPasta referenced this in commit 16b0fc1714 on Jun 27, 2021

PastaPastaPasta referenced this in commit c4442340fa on Jun 28, 2021

PastaPastaPasta referenced this in commit 10db7b9b13 on Jun 29, 2021

PastaPastaPasta referenced this in commit 664635643f on Jul 1, 2021

PastaPastaPasta referenced this in commit 101e2ba475 on Jul 1, 2021

PastaPastaPasta referenced this in commit 964a49ba49 on Jul 14, 2021

PastaPastaPasta referenced this in commit 9c6b782196 on Jul 14, 2021

DrahtBot locked this on Feb 15, 2022