Skip to content

Commit 671c609

Browse files
yardenshohamwxiaoguang6543techknowlogick
authored
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 <[email protected]> Co-authored-by: wxiaoguang <[email protected]> Co-authored-by: 6543 <[email protected]> Co-authored-by: techknowlogick <[email protected]>
1 parent a33ff82 commit 671c609

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,16 @@ If your PR could cause a breaking change you must add a BREAKING section to this
146146

147147
To explain how this could affect users and how to mitigate these changes.
148148

149+
Once code review starts on your PR, do not rebase nor squash your branch as it makes it
150+
difficult to review the new changes. Only if there is a need, sync your branch by merging
151+
the base branch into yours. Don't worry about merge commits messing up your tree as
152+
the final merge process squashes all commits into one, with the visible commit message (first
153+
line) being the PR title + PR index and description being the PR's first comment.
154+
155+
Once your PR gets the `lgtm/done` label, don't worry about keeping it up-to-date or breaking
156+
builds (unless there's a merge conflict or a request is made by a maintainer to make
157+
modifications). It is the maintainer team's responsibility from this point to get it merged.
158+
149159
## Styleguide
150160

151161
For imports you should use the following format (*without* the comments)

0 commit comments

Comments
 (0)