Skip to content

ai: add feature-description reference for release notes skill#23052

Merged
ti-chi-bot[bot] merged 3 commits into
pingcap:masterfrom
qiancai:skill-feature-description
Jun 12, 2026
Merged

ai: add feature-description reference for release notes skill#23052
ti-chi-bot[bot] merged 3 commits into
pingcap:masterfrom
qiancai:skill-feature-description

Conversation

@qiancai

@qiancai qiancai commented Jun 12, 2026

Copy link
Copy Markdown
Collaborator

What is changed, added or deleted? (Required)

This PR extends the existing write-review-translate-release-notes skill with a dedicated feature-description reference and related cross-link updates.

Purpose

Release note feature descriptions are often drafted from scattered inputs: a short feature specification, GitHub issue and PR links, benchmark notes, and documentation links. Without a focused workflow, drafts tend to summarize implementation work instead of explaining user-facing capability, value, and enablement steps.

This change adds references/feature-description.md so agents and contributors can turn those inputs into a release note entry that matches the ## Feature details / ## Features style in current TiDB release notes.

What changed

  • Added .ai/skills/write-review-translate-release-notes/references/feature-description.md with:
    • A quick workflow for extracting user-facing facts from PM/engineering input
    • Standard entry shape (title line, before/after paragraphs, optional details, documentation link)
    • Guidance for maturity tags (experimental, GA), section placement, style rules, examples, and a review checklist
  • Updated SKILL.md to route feature-description tasks to the new reference and keep the main skill focused on cross-cutting release note rules
  • Updated related references (bilingual-alignment.md, bug-fixes.md, improvements.md) and the skill description in .ai/AI-README.md

Benefits

  • Provides a single, repeatable path from feature inputs to a publishable release note feature entry
  • Keeps feature writing guidance separate from improvements, bug fixes, and compatibility changes
  • Encourages user-facing wording (problem, new capability, benefit) instead of implementation summaries
  • Improves consistency with published release note structure, formatting, and review expectations

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jun 12, 2026

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request expands the AI release notes skill and references to support the "Feature details/Features" sections in both English and Chinese, including the addition of a comprehensive feature-description.md reference file. The review feedback correctly identifies several examples and templates where historical version behaviors are described using the present tense, and provides actionable suggestions to use the past tense as required by the style guide.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Useful patterns:

```markdown
TiDB vX.Y.Z introduces <feature> as an experimental feature. In vA.B.C, this feature becomes generally available (GA).

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.

medium

According to the style guide, historical behavior should be described using the past tense. Since vX.Y.Z represents a past version relative to the current release vA.B.C, introduces should be in the past tense (introduced).

Suggested change
TiDB vX.Y.Z introduces <feature> as an experimental feature. In vA.B.C, this feature becomes generally available (GA).
TiDB vX.Y.Z introduced <feature> as an experimental feature. In vA.B.C, this feature becomes generally available (GA).
References
  1. Prefer present tense unless describing historical behavior. (link)

@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jun 12, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jun 12, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-06-12 10:25:05.932303893 +0000 UTC m=+1128407.002621273: ☑️ agreed by lilin90.

@qiancai

qiancai commented Jun 12, 2026

Copy link
Copy Markdown
Collaborator Author

/approve

@qiancai qiancai added the lgtm label Jun 12, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jun 12, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added the approved label Jun 12, 2026
@ti-chi-bot ti-chi-bot Bot merged commit 325930a into pingcap:master Jun 12, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm missing-translation-status This PR does not have translation status info. needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants