Skip to content

docs(agents): add release-title rule — name searchable features alongside the benefit - #677

Merged
ryanjwilke merged 2 commits into
mainfrom
ryanjwilke/release-title-feature-name-rule
Jun 2, 2026
Merged

docs(agents): add release-title rule — name searchable features alongside the benefit#677
ryanjwilke merged 2 commits into
mainfrom
ryanjwilke/release-title-feature-name-rule

Conversation

@ryanjwilke

@ryanjwilke ryanjwilke commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

What

Adds a Release titles rule to the design-system agent docs: release titles keep the benefit-first voice rule, but when a launch introduces a term people scan or search for (e.g. "Cloud MCP"), the title carries that name as a short prefix alongside the benefit.

  • Cloud MCP Beta: Debug failing tests with your AI assistant
  • not Debug failing tests with your AI assistant (beta)

Why

A release index is also a scan-and-navigate (and for some launches, search-and-discovery) surface. A benefit-only title can leave someone scanning the list unsure what actually shipped, and feature/category names aren't always self-explanatory on their own (e.g. "Smart Orchestration"). Engineers scanning the releases page for "MCP" couldn't tell we'd shipped it — the trigger for this rule.

Changes

  • .agents/principles/releases.md — new ## Release titles section (3 principles: lead-with-benefit-but-name-it, prefix the searchable term, don't force a name into every title).
  • .agents/voice.md — cross-link bullet under "Leading with value".

Scoped deliberately: applies only when the term carries recognition/SEO weight people actually search for, not every release.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only updates to internal agent guidance; no runtime, security, or customer-facing product behavior changes.

Overview
Adds agent documentation for how to write release titles on the releases index: keep benefit-first voice, but when a launch introduces a searchable product or feature name (e.g. Cloud MCP), use a short name prefix + benefit pattern such as Cloud MCP Beta: Debug failing tests with your AI assistant instead of burying the name or stage at the end.

A new Release titles section in releases.md spells out three rules (benefit plus discoverability, prefix recognizable terms, don’t force names on every release). voice.md gains a matching bullet under Leading with value with a cross-link back to that section.

Reviewed by Cursor Bugbot for commit ee44ea9. Bugbot is set up for automated code reviews on this repo. Configure here.

…side the benefit

Release titles follow the benefit-first voice rule, but a release index is
also a scan-and-search surface. When a launch introduces a term people look
for (e.g. "Cloud MCP"), the title should carry that name alongside the
benefit so the release is legible to scanners and search.

Adds a "Release titles" section to principles/releases.md and a cross-link
bullet under voice.md "Leading with value".

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 2, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cypress-design Ready Ready Preview Jun 2, 2026 4:11pm

Request Review

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds guidance to the internal agent docs for writing release titles that remain benefit-first while surfacing searchable feature names (e.g., “Cloud MCP”) as a short prefix for scan/search discoverability.

Changes:

  • Adds a new “Release titles” principle to the releases guidance.
  • Adds a matching cross-link bullet to the voice guidance under “Leading with value”.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
.agents/principles/releases.md Introduces a “Release titles” section describing when/how to prefix searchable terms while keeping benefit-focused phrasing.
.agents/voice.md Adds a bullet under “Leading with value” linking to the new release-title guidance.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .agents/principles/releases.md Outdated
@cypress

cypress Bot commented Jun 2, 2026

Copy link
Copy Markdown

cypress-design    Run #3748

Run Properties:  status check passed Passed #3748  •  git commit 6855570dcb ℹ️: Merge 2c32b4924bb1e15e2c712cd36f1fd406e2585c82 into 344248d8c26c2ccf7cddf0410511...
Project cypress-design
Branch Review ryanjwilke/release-title-feature-name-rule
Run status status check passed Passed #3748
Run duration 02m 26s
Commit git commit 6855570dcb ℹ️: Merge 2c32b4924bb1e15e2c712cd36f1fd406e2585c82 into 344248d8c26c2ccf7cddf0410511...
Committer Ryan Wilke
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 2
View all changes introduced in this branch ↗︎

Warning

No Report: Something went wrong and we could not generate a report for the Application Quality products.

Address review note that para 1 ("open on the outcome") read as
contradicting para 2 ("lead with the name"). Reframe the prefix as a tag
on the benefit-led phrasing rather than the lead, removing the tension.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@changeset-bot

changeset-bot Bot commented Jun 2, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 2c32b49

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@ryanjwilke
ryanjwilke merged commit 138719a into main Jun 2, 2026
22 of 24 checks passed
@ryanjwilke
ryanjwilke deleted the ryanjwilke/release-title-feature-name-rule branch June 2, 2026 16:49
@cypress

cypress Bot commented Jun 2, 2026

Copy link
Copy Markdown

cypress-design    Run #3750

Run Properties:  status check passed Passed #3750  •  git commit 138719a91b: docs(agents): add release-title rule — name searchable features alongside the be...
Project cypress-design
Branch Review main
Run status status check passed Passed #3750
Run duration 02m 19s
Commit git commit 138719a91b: docs(agents): add release-title rule — name searchable features alongside the be...
Committer Ryan Wilke
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 2
View all changes introduced in this branch ↗︎

Warning

No Report: Something went wrong and we could not generate a report for the Application Quality products.

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.

2 participants