From dfdc6ab1286c32a2cf4390d85609e71faa946f32 Mon Sep 17 00:00:00 2001 From: Yan Avlasov Date: Tue, 28 Sep 2021 13:15:54 -0400 Subject: [PATCH 1/2] Update PR template to include the "Fixes commit" message when reverting or fixing bad commits Signed-off-by: Yan Avlasov --- PULL_REQUESTS.md | 13 +++++++++++++ PULL_REQUEST_TEMPLATE.md | 1 + 2 files changed, 14 insertions(+) diff --git a/PULL_REQUESTS.md b/PULL_REQUESTS.md index 97efd55d01fe..7fb18f6497f9 100644 --- a/PULL_REQUESTS.md +++ b/PULL_REQUESTS.md @@ -102,6 +102,19 @@ you may instead just tag the PR with the issue: \#Issue +### Commit + +If this PR fixes or reverts a buggy commit, please add a line of the form: + +Fixes commit #PR + +or + +Fixes commit SHA + +This will allow automated tools to detect tainted commit ranges on the main branch when the PR is +merged. + ### Deprecated If this PR deprecates existing Envoy APIs or code, it should include an update to the deprecated diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 73e13c82eea3..d980fa3b2e5c 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -21,5 +21,6 @@ Release Notes: Platform Specific Features: [Optional Runtime guard:] [Optional Fixes #Issue] +[Optional Fixes commit #PR or commit SHA] [Optional Deprecated:] [Optional [API Considerations](https://github.com/envoyproxy/envoy/blob/main/api/review_checklist.md):] From 5f45daa2480868ad643a41d15be586c26062fad5 Mon Sep 17 00:00:00 2001 From: Yan Avlasov Date: Tue, 28 Sep 2021 13:18:53 -0400 Subject: [PATCH 2/2] Update Signed-off-by: Yan Avlasov --- PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index d980fa3b2e5c..27f0f9ef9df8 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -21,6 +21,6 @@ Release Notes: Platform Specific Features: [Optional Runtime guard:] [Optional Fixes #Issue] -[Optional Fixes commit #PR or commit SHA] +[Optional Fixes commit #PR or SHA] [Optional Deprecated:] [Optional [API Considerations](https://github.com/envoyproxy/envoy/blob/main/api/review_checklist.md):]