Repository navigation
docs: suggest a short PR opener with the long description folded - #118
Merged
Merged
Conversation
Most PR descriptions here are agent-written and run to 40-140 lines. Ask for a one-to-three sentence opener, keep what reviewers check in view (tested environment, unverified behaviour, remaining warnings, new access or minimum version), and fold the rest in <details><summary>, following https://simonwillison.net/2026/Nov/9/details-summary/. It is a suggestion, not a review gate. Assisted-by: Claude Opus 5.5 (OpenCode)
MyPrototypeWhat
force-pushed
the
docs/pr-description-format
branch
from
November 9, 2026 08:15
e2390cc to
718b380
Compare
GitHub renders Markdown inside <details> only after a blank line that follows </summary>; the one-line example invited broken rendering. CONTRIBUTING now asks for one to three opener sentences, as AGENTS.md does. Assisted-by: Claude Opus 5.5 (OpenCode)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR descriptions here keep getting longer (the last 15 average 50 lines, the 15 before them 25), and none of them fold anything. This suggests a short opener, with what reviewers need kept in view and the rest folded under
<details><summary>, following Simon Willison's write-up. It is a suggestion, not a review gate.Verified:
npm run checkpasses (0 errors, 92 tests). Docs only:AGENTS.md,CONTRIBUTING.md,CONTRIBUTING.zh-CN.md.Not verified: whether contributors' agents follow it. That will show in the next few PRs.
Written by Claude Opus 5.5
Why
Of the last 30 PRs (#87–#117), 24 descriptions run 2,000 to 6,000 characters; the median is 27 lines, and #107 reaches 136 (#105, mine, is 88). None of them use
<details>. GitHub renders<details><summary>in PR descriptions, and this repository's squash setting builds the commit message from the commits rather than the PR body (squash_merge_commit_message: COMMIT_MESSAGES), so the HTML never reachesgit log.What changed
AGENTS.md:npm run checkwarning with its reason, and any new access or higher minimum client version.<details><summary>Written by <model></summary>, where<model>is whichever model wrote it. A blank line must follow</summary>: without it GitHub shows the Markdown inside as plain text (checked with the GitHub Markdown API).AGENTS.md, "Change the checks or the docs": maintainers describe their PRs the same way.CONTRIBUTING.md/CONTRIBUTING.zh-CN.md: if an AI agent wrote the description, write its first one to three sentences yourself, keep test results and unverified behaviour visible, and fold the rest, with the same blank line.Not changed