ai: add feature-description reference for release notes skill#23052
Conversation
There was a problem hiding this comment.
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). |
There was a problem hiding this comment.
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).
| 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
- Prefer present tense unless describing historical behavior. (link)
[LGTM Timeline notifier]Timeline:
|
|
/approve |
|
[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 DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What is changed, added or deleted? (Required)
This PR extends the existing
write-review-translate-release-notesskill 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.mdso agents and contributors can turn those inputs into a release note entry that matches the## Feature details/## Featuresstyle in current TiDB release notes.What changed
.ai/skills/write-review-translate-release-notes/references/feature-description.mdwith:experimental, GA), section placement, style rules, examples, and a review checklistSKILL.mdto route feature-description tasks to the new reference and keep the main skill focused on cross-cutting release note rulesbilingual-alignment.md,bug-fixes.md,improvements.md) and the skill description in.ai/AI-README.mdBenefits
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?