From a7cb72198e0d8a956ec301970f8522804878f31a Mon Sep 17 00:00:00 2001 From: Arik Kfir Date: Fri, 3 May 2024 20:57:09 +0300 Subject: [PATCH] docs: minor edit to CONTRIBUTING.md --- CONTRIBUTING.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f4aacd9..df94c29 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,7 +96,12 @@ Here are a few things you can do that will increase the likelihood of your pull ### Merging strategy -The `main` branch must retain linear history, and that means the only allowed merge strategy in this repository is the "Rebase" strategy. It also means that reviews must be done on the tip of the PR, and once you rebase or force-push to restructure commits, another review will be required. +Following restrictions apply: + +- Linear history is required for the `main` branch +- That means your branch must be up-to-date and rebased on top of the `main` branch before merging +- That might also mean that occasionally re-review might be warranted if `main` has changed after the PR was approved +- The only merging strategy allowed for PRs is "Squash and merge" ## Resources