Skip to content

docs: suggest a short PR opener with the long description folded - #118

Merged
MyPrototypeWhat merged 2 commits into
mainfrom
docs/pr-description-format
Nov 9, 2026
Merged

MyPrototypeWhat merged 2 commits into
mainfrom
docs/pr-description-format

Conversation

@MyPrototypeWhat

@MyPrototypeWhat MyPrototypeWhat commented Nov 9, 2026 •

Copy link
Copy Markdown
Collaborator

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 check passes (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 reaches git log.

What changed

  • AGENTS.md:
    • A new step 6 in "Add or update a Mini App": open with one to three sentences on what changed and why, plus a screenshot when the page looks different.
    • These stay visible below the opener, because they are what review checks: the tested environment and results, what was not verified, each remaining npm run check warning with its reason, and any new access or higher minimum client version.
    • The rest goes into <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).
    • The agent asks the person it works for to read and edit the opener before submitting. An opener written by the agent alone loses the point of the method, which is that those first lines reflect a person's judgement.
  • 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

  • The review policy still gates on three things only.
  • There is no CI check for PR format.

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
MyPrototypeWhat force-pushed the docs/pr-description-format branch from e2390cc to 718b380 Compare November 9, 2026 08:15
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)
@MyPrototypeWhat
MyPrototypeWhat merged commit 25bffc7 into main Nov 9, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant