From 2fcdbeb1f722b7d76b4cfb328ea56f655dc0a441 Mon Sep 17 00:00:00 2001 From: Tom Hennen Date: Tue, 24 Sep 2024 13:35:49 +0000 Subject: [PATCH 1/6] nonspec: Suggest people assign reviewers to PRs Suggest PR authors assign specific reviewers and ping the Slack channel if they want. The goal is to make it more clear who is expected to take the next action on PRs vs the current situation where the maintainers may think someone else will take a look or that they may have missed the initial PR request. fixes #1149 Signed-off-by: Tom Hennen --- CONTRIBUTING.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d13f4479..9467ef4df 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -160,16 +160,26 @@ Review process: 1. Ensure that the PR meets the [pull request conventions]. -2. GitHub will automatically assign the maintainers as reviewers. You will need - a different number of approvals for different PR types. Your reviewers may - ask that you use a different PR type. - -3. Wait an appropriate amount of time to allow for lazy consensus. Different +2. If there is a particular set of maintainers you've been working with, feel + free to assign the PR to them. If they don't have time to review they + should feel free to assign to someone else, or provide feedback on when + they can get to it. Otherwise, assign to + `@slsa-framework/specification-maintainers`. + - Feel free to ping the reviwers in the + [slsa-specification Slack](https://openssf.slack.com/archives/C03NUSAPKC6) + when the PR is ready for review. + +3. You will need a different number of approvals for different PR types. Your + reviewers may ask that you use a different PR type. + +4. Wait an appropriate amount of time to allow for lazy consensus. Different types have different minimum waiting periods. The waiting period begins at the timestamp of either the final required approval or the latest non-author comment, whichever is later. + - If a few days have passed without any feedback please feel free to ping + the PR and in Slack. -4. Once the waiting period has passed, a maintainer will merge your PR. Expect +5. Once the waiting period has passed, a maintainer will merge your PR. Expect your PR to be squashed+merged unless your reviewers advise you otherwise. If your PR has not been merged within 48h of the waiting period having passed, and a reason for that has not been added as a PR comment, use the From 7fb6b7c5c2543ee160a752ce49c7307549240af6 Mon Sep 17 00:00:00 2001 From: Tom Hennen Date: Tue, 24 Sep 2024 15:10:49 +0000 Subject: [PATCH 2/6] different number of approvals should be sub-bullet Signed-off-by: Tom Hennen --- CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9467ef4df..c83af9618 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -168,18 +168,17 @@ Review process: - Feel free to ping the reviwers in the [slsa-specification Slack](https://openssf.slack.com/archives/C03NUSAPKC6) when the PR is ready for review. - -3. You will need a different number of approvals for different PR types. Your + - You will need a different number of approvals for different PR types. Your reviewers may ask that you use a different PR type. -4. Wait an appropriate amount of time to allow for lazy consensus. Different +3. Wait an appropriate amount of time to allow for lazy consensus. Different types have different minimum waiting periods. The waiting period begins at the timestamp of either the final required approval or the latest non-author comment, whichever is later. - If a few days have passed without any feedback please feel free to ping the PR and in Slack. -5. Once the waiting period has passed, a maintainer will merge your PR. Expect +4. Once the waiting period has passed, a maintainer will merge your PR. Expect your PR to be squashed+merged unless your reviewers advise you otherwise. If your PR has not been merged within 48h of the waiting period having passed, and a reason for that has not been added as a PR comment, use the From e27ef42d3c56f4667b593e84ebd821be0c2f4412 Mon Sep 17 00:00:00 2001 From: Tom Hennen Date: Tue, 24 Sep 2024 15:12:20 +0000 Subject: [PATCH 3/6] link to slack Signed-off-by: Tom Hennen --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c83af9618..f9239bcaa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -176,7 +176,7 @@ Review process: the timestamp of either the final required approval or the latest non-author comment, whichever is later. - If a few days have passed without any feedback please feel free to ping - the PR and in Slack. + the PR and [in Slack](https://openssf.slack.com/archives/C03NUSAPKC6). 4. Once the waiting period has passed, a maintainer will merge your PR. Expect your PR to be squashed+merged unless your reviewers advise you otherwise. From 82f3288899a2184a1a74d27e167e6de6033789e4 Mon Sep 17 00:00:00 2001 From: Tom Hennen Date: Tue, 24 Sep 2024 13:09:56 -0400 Subject: [PATCH 4/6] Update CONTRIBUTING.md Co-authored-by: Marcela Melara Signed-off-by: Tom Hennen --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f9239bcaa..2339ef102 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -168,7 +168,7 @@ Review process: - Feel free to ping the reviwers in the [slsa-specification Slack](https://openssf.slack.com/archives/C03NUSAPKC6) when the PR is ready for review. - - You will need a different number of approvals for different PR types. Your + - You will need a different number of approvals for different [PR types](#pull-request-types). Your reviewers may ask that you use a different PR type. 3. Wait an appropriate amount of time to allow for lazy consensus. Different From ac429db831b7d34c2c3bd66bc983fab7dd638437 Mon Sep 17 00:00:00 2001 From: Tom Hennen Date: Tue, 24 Sep 2024 17:12:13 +0000 Subject: [PATCH 5/6] adjust formatting Signed-off-by: Tom Hennen --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2339ef102..78a87a01c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -168,8 +168,9 @@ Review process: - Feel free to ping the reviwers in the [slsa-specification Slack](https://openssf.slack.com/archives/C03NUSAPKC6) when the PR is ready for review. - - You will need a different number of approvals for different [PR types](#pull-request-types). Your - reviewers may ask that you use a different PR type. + - You will need a different number of approvals for different + [PR types](#pull-request-types). Your reviewers may ask that you use a + different PR type. 3. Wait an appropriate amount of time to allow for lazy consensus. Different types have different minimum waiting periods. The waiting period begins at From c8dda837d5ef1a2882a1be7fe4ffd8f2ac7340d0 Mon Sep 17 00:00:00 2001 From: Tom Hennen Date: Tue, 24 Sep 2024 17:14:00 +0000 Subject: [PATCH 6/6] really fix formatting Signed-off-by: Tom Hennen --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 78a87a01c..3279b9059 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -169,8 +169,8 @@ Review process: [slsa-specification Slack](https://openssf.slack.com/archives/C03NUSAPKC6) when the PR is ready for review. - You will need a different number of approvals for different - [PR types](#pull-request-types). Your reviewers may ask that you use a - different PR type. + [PR types](#pull-request-types). Your reviewers may ask that you use a + different PR type. 3. Wait an appropriate amount of time to allow for lazy consensus. Different types have different minimum waiting periods. The waiting period begins at