From e4fc1acd31450c0b4ef90b9b58aa2dcd31a1a38b Mon Sep 17 00:00:00 2001 From: Yarden Shoham Date: Sat, 15 Oct 2022 20:09:39 +0300 Subject: [PATCH] Add Code Review section to CONTRIBUTING.md (#1274) Signed-off-by: Yarden Shoham --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index daa2cd0d9..60913e2f4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,6 +39,18 @@ they served: * 2019-07-25 ~ 2021-09-28 * [Laszlo Fogas](https://github.com/laszlocph) +## Code Review + +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 approved, 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. + ## Versioning We use [Semantic Versioning](https://semver.org/) to be able,