From fc49355a1e1ac6d5ff6f50ad93e9abbab2844934 Mon Sep 17 00:00:00 2001 From: Asra Ali Date: Wed, 22 Apr 2020 13:30:14 -0400 Subject: [PATCH 1/3] PR template Signed-off-by: Asra Ali --- CONTRIBUTING.md | 6 +++++- PULL_REQUESTS.md | 20 ++++++++++++++------ PULL_REQUEST_TEMPLATE.md | 3 ++- 3 files changed, 21 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ffd804f25b81..2b8723439638 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,6 +97,8 @@ versioning guidelines: colon. Examples: * "docs: fix grammar error" * "http conn man: add new feature" +* Your PR commit message will be used as the commit message when your PR is merged. You should + update this field if your PR diverges during review. * Your PR description should have details on what the PR does. If it fixes an existing issue it should end with "Fixes #XXX". * When all of the tests are passing and all other conditions described herein are satisfied, a @@ -190,10 +192,12 @@ and false. organization specific shortcuts into the code. * If there is a question on who should review a PR please discuss in Slack. * Anyone is welcome to review any PR that they want, whether they are a maintainer or not. +* Please make sure that the PR title, commit message, and description are updated if the PR changes + significantly during review. * Please **clean up the title and body** before merging. By default, GitHub fills the squash merge title with the original title, and the commit body with every individual commit from the PR. The maintainer doing the merge should make sure the title follows the guidelines above and should - overwrite the body with the original extended description from the PR (cleaning it up if necessary) + overwrite the body with the original commit message from the PR (cleaning it up if necessary) while preserving the PR author's final DCO sign-off. * If a PR includes a deprecation/breaking change, notification should be sent to the [envoy-announce](https://groups.google.com/forum/#!forum/envoy-announce) email list. diff --git a/PULL_REQUESTS.md b/PULL_REQUESTS.md index deb77bb326fd..f4127bf0ea2f 100644 --- a/PULL_REQUESTS.md +++ b/PULL_REQUESTS.md @@ -12,13 +12,21 @@ explaining the overall change. Both the component and the explanation must be lo * router:add x-envoy-overloaded header * tls: add support for specifying TLS session ticket keys -### Description +### Commit Message -The description field should include a more verbose explanation of what this PR -does. If this PR causes a change in behavior it should document the behavior -before and after If fixing a bug, please describe what the original issue is and -how the change resolves it. If it is configuration controlled, it should note -how the feature is enabled etc... +The commit message field should include an explanation of what this PR +does. This will be used as the final commit message that maintainers will use to +populate the commit message when merging. If this PR causes a change in behavior +it should document the behavior before and after. If fixing a bug, please +describe what the original issue is and how the change resolves it. If it is +configuration controlled, it should note how the feature is enabled etc... + + +### Detailed Description + +The description field should include additional information of what this PR does +that may be out of scope for a commit message. This could include additional +information or context useful to reviewers. ### Risk diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index f8bb15ff43e4..4126c47f98f8 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,8 @@ For an explanation of how to fill out the fields, please see the relevant section in [PULL_REQUESTS.md](https://github.com/envoyproxy/envoy/blob/master/PULL_REQUESTS.md) -Description: +Commit Message: +Detailed Description: Risk Level: Testing: Docs Changes: From 90e2b998f1c3d7b0e0fd4e083914794987827f46 Mon Sep 17 00:00:00 2001 From: Asra Ali Date: Wed, 22 Apr 2020 15:01:17 -0400 Subject: [PATCH 2/3] change to additional description Signed-off-by: Asra Ali --- PULL_REQUESTS.md | 4 +- PULL_REQUEST_TEMPLATE.md | 2 +- ...ized-codec_impl_fuzz_test-5662032457367552 | 41 +++++++++++++++++++ 3 files changed, 44 insertions(+), 3 deletions(-) create mode 100644 test/common/http/codec_impl_corpus/clusterfuzz-testcase-minimized-codec_impl_fuzz_test-5662032457367552 diff --git a/PULL_REQUESTS.md b/PULL_REQUESTS.md index f4127bf0ea2f..0126cf073ea6 100644 --- a/PULL_REQUESTS.md +++ b/PULL_REQUESTS.md @@ -22,9 +22,9 @@ describe what the original issue is and how the change resolves it. If it is configuration controlled, it should note how the feature is enabled etc... -### Detailed Description +### Additional Description -The description field should include additional information of what this PR does +The additional description field should include information of what this PR does that may be out of scope for a commit message. This could include additional information or context useful to reviewers. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 4126c47f98f8..e16c81139d86 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -2,7 +2,7 @@ For an explanation of how to fill out the fields, please see the relevant sectio in [PULL_REQUESTS.md](https://github.com/envoyproxy/envoy/blob/master/PULL_REQUESTS.md) Commit Message: -Detailed Description: +Additional Description: Risk Level: Testing: Docs Changes: diff --git a/test/common/http/codec_impl_corpus/clusterfuzz-testcase-minimized-codec_impl_fuzz_test-5662032457367552 b/test/common/http/codec_impl_corpus/clusterfuzz-testcase-minimized-codec_impl_fuzz_test-5662032457367552 new file mode 100644 index 000000000000..b3a143f9b8e3 --- /dev/null +++ b/test/common/http/codec_impl_corpus/clusterfuzz-testcase-minimized-codec_impl_fuzz_test-5662032457367552 @@ -0,0 +1,41 @@ +actions { + new_stream { + request_headers { + headers { + key: ":method" + value: "GET" + } + headers { + key: ":path" + value: "/" + } + } + } +} +actions { + client_drain { + } +} +actions { + stream_action { + response { + headers { + } + end_stream: true + } + } +} +actions { + stream_action { + request { + data: 0 + end_stream: true + } + } +} +actions { + new_stream { + request_headers { + } + } +} \ No newline at end of file From 223d0bf6c64cc61344918d7d6d71dda6ff18a638 Mon Sep 17 00:00:00 2001 From: Asra Ali Date: Wed, 22 Apr 2020 15:04:03 -0400 Subject: [PATCH 3/3] dont work too fast Signed-off-by: Asra Ali --- ...ized-codec_impl_fuzz_test-5662032457367552 | 41 ------------------- 1 file changed, 41 deletions(-) delete mode 100644 test/common/http/codec_impl_corpus/clusterfuzz-testcase-minimized-codec_impl_fuzz_test-5662032457367552 diff --git a/test/common/http/codec_impl_corpus/clusterfuzz-testcase-minimized-codec_impl_fuzz_test-5662032457367552 b/test/common/http/codec_impl_corpus/clusterfuzz-testcase-minimized-codec_impl_fuzz_test-5662032457367552 deleted file mode 100644 index b3a143f9b8e3..000000000000 --- a/test/common/http/codec_impl_corpus/clusterfuzz-testcase-minimized-codec_impl_fuzz_test-5662032457367552 +++ /dev/null @@ -1,41 +0,0 @@ -actions { - new_stream { - request_headers { - headers { - key: ":method" - value: "GET" - } - headers { - key: ":path" - value: "/" - } - } - } -} -actions { - client_drain { - } -} -actions { - stream_action { - response { - headers { - } - end_stream: true - } - } -} -actions { - stream_action { - request { - data: 0 - end_stream: true - } - } -} -actions { - new_stream { - request_headers { - } - } -} \ No newline at end of file