Skip to content

Commit 46da446

Browse files
committed
doc: add text about moving long commit lists out of PR description
1 parent b986609 commit 46da446

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

doc/guides/releases.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,19 @@ Create a pull request targeting the correct release line. For example, a
398398
`v5.3.0-proposal` PR should target `v5.x`, not master. Paste the CHANGELOG
399399
modifications into the body of the PR so that collaborators can see what is
400400
changing. These PRs should be left open for at least 24 hours, and can be
401-
updated as new commits land.
401+
updated as new commits land. If the CHANGELOG is long enough that it slows
402+
down the GitHub UI, consider pasting the commits into `<details>` tags or
403+
in follow up comments.
404+
405+
If using the `<details>` tag, use the following format:
406+
407+
```markdown
408+
<details>
409+
<summary>Commits</summary>
410+
411+
* Full list of commits...
412+
</details>
413+
```
402414

403415
If you need any additional information about any of the commits, this PR is a
404416
good place to @-mention the relevant contributors.

0 commit comments

Comments
 (0)