From 893492ffeb00ec870789355aa8a43403c838df39 Mon Sep 17 00:00:00 2001 From: Yarden Shoham Date: Sat, 15 Oct 2022 13:48:24 +0000 Subject: [PATCH 01/11] Add wording about keeping PRs up-to-date in CONTRIBUTING.md 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 --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4aff27fc65c8c..6ff61756eba9d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -146,6 +146,13 @@ 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 your branch as it makes it +difficult to review your code. 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, using the description of 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. It is the maintainer team's responsability from this point to get it merged. + ## Styleguide For imports you should use the following format (*without* the comments) From 16a66f4872b8beef44a7f84eeac9e02d16d21762 Mon Sep 17 00:00:00 2001 From: Yarden Shoham Date: Sat, 15 Oct 2022 13:51:36 +0000 Subject: [PATCH 02/11] Break line Signed-off-by: Yarden Shoham --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6ff61756eba9d..4d9aee4db57cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -151,7 +151,8 @@ difficult to review your code. Only if there is a need, sync your branch by merg 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, using the description of 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. It is the maintainer team's responsability from this point to get it merged. +Once your PR gets the `lgtm/done` label, don't worry about keeping it up-to-date or breaking builds. +It is the maintainer team's responsability from this point to get it merged. ## Styleguide From c789b37b92e178bfc934826cd7b3d02b678fedc3 Mon Sep 17 00:00:00 2001 From: Yarden Shoham Date: Sat, 15 Oct 2022 13:52:13 +0000 Subject: [PATCH 03/11] Fix typo Signed-off-by: Yarden Shoham --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d9aee4db57cd..476c9262adfbb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -152,7 +152,7 @@ the base branch into yours. Don't worry about merge commits messing up your tree the final merge process squashes all commits into one, using the description of 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. -It is the maintainer team's responsability from this point to get it merged. +It is the maintainer team's responsibility from this point to get it merged. ## Styleguide From f755db27b6e5318538904093311c64c8b6756fac Mon Sep 17 00:00:00 2001 From: wxiaoguang Date: Sat, 15 Oct 2022 21:53:42 +0800 Subject: [PATCH 04/11] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 476c9262adfbb..7446ba531f710 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -146,7 +146,7 @@ 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 your branch as it makes it +Once code review starts on your PR, do not rebase or squash your branch as it makes it difficult to review your code. 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, using the description of the PR's first comment. From 2dcc120cb787e752424a9d5c4df99e2df83950aa Mon Sep 17 00:00:00 2001 From: wxiaoguang Date: Sat, 15 Oct 2022 21:54:28 +0800 Subject: [PATCH 05/11] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7446ba531f710..716887825dcd8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -147,7 +147,7 @@ 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 or squash your branch as it makes it -difficult to review your code. Only if there is a need, sync your branch by merging +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, using the description of the PR's first comment. From 82f3b730fab7fbc6fdede08fdf7d37348a8830f4 Mon Sep 17 00:00:00 2001 From: Yarden Shoham Date: Sat, 15 Oct 2022 13:55:29 +0000 Subject: [PATCH 06/11] or -> nor --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 716887825dcd8..cb1cb3213c58c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -146,7 +146,7 @@ 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 or squash your branch as it makes it +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, using the description of the PR's first comment. From d95134f5ee98fe2df2fd888faeefbe6b79cebc24 Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Sat, 15 Oct 2022 15:58:49 +0200 Subject: [PATCH 07/11] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cb1cb3213c58c..d03546209371c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -149,7 +149,7 @@ 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, using the description of the PR's first comment. +the final merge process squashes all commits into one, using the description of the Pull. Once your PR gets the `lgtm/done` label, don't worry about keeping it up-to-date or breaking builds. It is the maintainer team's responsibility from this point to get it merged. From 15e871b65eb5f3ecc393b571200048cee29353ea Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Sat, 15 Oct 2022 15:59:15 +0200 Subject: [PATCH 08/11] make it same --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d03546209371c..96bd3758763e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -149,7 +149,7 @@ 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, using the description of the Pull. +the final merge process squashes all commits into one, using the description of the PR. Once your PR gets the `lgtm/done` label, don't worry about keeping it up-to-date or breaking builds. It is the maintainer team's responsibility from this point to get it merged. From e36f677b0360d93749d3644bb41e66a8c7150546 Mon Sep 17 00:00:00 2001 From: Yarden Shoham Date: Sat, 15 Oct 2022 15:15:33 +0000 Subject: [PATCH 09/11] Clarify commit message --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96bd3758763e0..aecb77a1ea585 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -149,7 +149,8 @@ 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, using the description of the PR. +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. It is the maintainer team's responsibility from this point to get it merged. From e0a0ac11d61e1de7e8b5b0c3e81fe566e74e7e8a Mon Sep 17 00:00:00 2001 From: Yarden Shoham Date: Sat, 15 Oct 2022 15:31:16 +0000 Subject: [PATCH 10/11] Unless there's a merge conflict --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aecb77a1ea585..4fed38f713961 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -152,8 +152,8 @@ the base branch into yours. Don't worry about merge commits messing up your tree 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. -It is the maintainer team's responsibility from this point to get it merged. +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 From 1360ab29787636a49c840c224d332a97b4e3f436 Mon Sep 17 00:00:00 2001 From: Yarden Shoham Date: Sat, 15 Oct 2022 15:32:50 +0000 Subject: [PATCH 11/11] Break line --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4fed38f713961..dbe418c3563a8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -152,7 +152,8 @@ the base branch into yours. Don't worry about merge commits messing up your tree 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 +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