Skip to content

Write release copy for users, not developers #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
badcuban merged 1 commit into from
Aug 10, 2026
Merged

Write release copy for users, not developers #139

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion scripts/generate-release-content.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,10 +278,13 @@ function buildPrompt(input: GenerateReleaseContentInput): string {
"- Every highlight and smaller improvement must cite one or more exact short hashes from the supplied evidence.",
"- Do not invent capabilities, outcomes, metrics, dates, platforms, or roadmap claims.",
"- Use direct, restrained language. Avoid hype, superlatives, and implementation jargon.",
"- Write for a user reading their feed, not a developer reading a diff: say what the person can now do or what they will see on screen, in plain words. 'Warnings collapse into one slim row above the message box' beats 'Docked composer notices'.",
"- Never use internal feature or component names in user-facing copy. If a name is unavoidable, describe how the thing looks or behaves instead.",
"- Never use em dashes in any copy. Use a period, comma, colon, or parentheses.",
"- The title must be a short release theme and must not repeat the product name or version.",
"- The summary must be one complete sentence under 220 characters; never cut off a word or sentence to reach the limit.",
`- The social post must begin exactly with 'Threadlines v${input.version} is out ${SOCIAL_BRAND_MARKER}', end exactly with 'Release notes: ${releaseUrl(input.repository, input.version)}' so X renders GitHub's release card, and remain at or below ${MAX_SOCIAL_CHARACTERS} Unicode characters.`,
"- The social post should contain at most four compact bullets, each ideally under 50 characters, and must only mention claims present in the highlights or smaller improvements.",
"- The social post should contain at most four bullets, each a plain phrase a reader who has never opened the app would understand, ideally under 60 characters, and must only mention claims present in the highlights or smaller improvements.",
"",
`Version: ${input.version}`,
`Release date: ${input.releaseDate}`,
Expand Down
Loading