From 46da446711a56fbf8a53714d4555e2216e47947a Mon Sep 17 00:00:00 2001 From: Danielle Adams Date: Mon, 28 Jun 2021 12:58:22 -0400 Subject: [PATCH] doc: add text about moving long commit lists out of PR description --- doc/guides/releases.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/doc/guides/releases.md b/doc/guides/releases.md index 832b8c8eda0680..8542d4c8721233 100644 --- a/doc/guides/releases.md +++ b/doc/guides/releases.md @@ -398,7 +398,19 @@ Create a pull request targeting the correct release line. For example, a `v5.3.0-proposal` PR should target `v5.x`, not master. Paste the CHANGELOG modifications into the body of the PR so that collaborators can see what is changing. These PRs should be left open for at least 24 hours, and can be -updated as new commits land. +updated as new commits land. If the CHANGELOG is long enough that it slows +down the GitHub UI, consider pasting the commits into `
` tags or +in follow up comments. + +If using the `
` tag, use the following format: + +```markdown +
+Commits + +* Full list of commits... +
+``` If you need any additional information about any of the commits, this PR is a good place to @-mention the relevant contributors.