From 671c609c465f02d7ac5023bb8491694a9f4768f5 Mon Sep 17 00:00:00 2001 From: Yarden Shoham Date: Sat, 15 Oct 2022 19:41:24 +0300 Subject: [PATCH] Add wording about keeping PRs up-to-date in CONTRIBUTING.md (#21468) Following a discord discussion from today I've written the policy explained to me about keeping PRs up-to-date. Signed-off-by: Yarden Shoham Co-authored-by: wxiaoguang Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: techknowlogick --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4aff27fc6..dbe418c35 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -146,6 +146,16 @@ If your PR could cause a breaking change you must add a BREAKING section to this To explain how this could affect users and how to mitigate these changes. +Once code review starts on your PR, do not rebase nor squash your branch as it makes it +difficult to review the new changes. Only if there is a need, sync your branch by merging +the base branch into yours. Don't worry about merge commits messing up your tree as +the final merge process squashes all commits into one, with the visible commit message (first +line) being the PR title + PR index and description being the PR's first comment. + +Once your PR gets the `lgtm/done` label, don't worry about keeping it up-to-date or breaking +builds (unless there's a merge conflict or a request is made by a maintainer to make +modifications). It is the maintainer team's responsibility from this point to get it merged. + ## Styleguide For imports you should use the following format (*without* the comments)