ai: add release notes SKILL#22712
Conversation
ti-chi-bot
bot
added
the
size/XXL
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive AI skill for writing, reviewing, and translating TiDB release notes, including detailed reference guides for bug fixes, improvements, and compatibility changes. The documentation establishes strict style rules for both English and Chinese content, such as specific opening verbs, inline code conventions, and bilingual alignment workflows. The review feedback focuses on improving the clarity and directness of these instructions by adhering to the style guide's preference for active voice and second-person address.
.ai/skills/write-review-translate-release-notes/references/bilingual-alignment.md
Outdated
Show resolved
Hide resolved
.ai/skills/write-review-translate-release-notes/references/bilingual-alignment.md
Outdated
Show resolved
Hide resolved
.ai/skills/write-review-translate-release-notes/references/bug-fixes.md
Outdated
Show resolved
Hide resolved
| * `修复 [X] 的问题` (most common) | ||
| * `修复 [X] 可能 [崩溃/panic/卡住/报错] 的问题` (non-deterministic failures) | ||
| * `修复 [X] 导致 [Y] 的问题` (cause-effect issues) | ||
| * `禁止 [X]` (used when the fix introduces a restriction rather than a repair; rare) |
There was a problem hiding this comment.
Use active voice in the parenthetical instruction to follow the style guide.
| * `禁止 [X]` (used when the fix introduces a restriction rather than a repair; rare) | |
| * 禁止 [X] (Use this when the fix introduces a restriction rather than a repair; rare) |
References
- Avoid passive voice overuse. (link)
.ai/skills/write-review-translate-release-notes/references/compatibility-changes.md
Outdated
Show resolved
Hide resolved
.ai/skills/write-review-translate-release-notes/references/compatibility-changes.md
Outdated
Show resolved
Hide resolved
.ai/skills/write-review-translate-release-notes/references/compatibility-changes.md
Outdated
Show resolved
Hide resolved
| - Entry [#NNNNN](https://github.com/pingcap/tidb/issues/NNNNN) @[contributor](https://github.com/contributor) | ||
| ``` | ||
|
|
||
| Component groups use `+`, and individual entries use `-`. Tools are nested one level deeper under `+ Tools`. |
There was a problem hiding this comment.
Use active voice for the instruction regarding nesting tools.
| Component groups use `+`, and individual entries use `-`. Tools are nested one level deeper under `+ Tools`. | |
| Component groups use `+`, and individual entries use `-`. Nest tools one level deeper under `+ Tools`. |
References
- Avoid passive voice overuse. (link)
|
|
||
| State the user benefit explicitly. Explain why the change matters in terms of performance, stability, or capability. For example, instead of "Not use the stale read request's `start_ts` to update `max_ts`," write "Avoid excessive commit request retrying by not using the Stale Read request's `start_ts` to update `max_ts`." | ||
|
|
||
| Metric claims are encouraged when sourced, such as "up to 10 times performance improvement" or "improves performance by up to 62.5%." |
There was a problem hiding this comment.
Use active voice and address the user directly to encourage best practices.
| Metric claims are encouraged when sourced, such as "up to 10 times performance improvement" or "improves performance by up to 62.5%." | |
| Encourage metric claims when you have a source, such as "up to 10 times performance improvement" or "improves performance by up to 62.5%." |
.ai/skills/write-review-translate-release-notes/references/compatibility-changes.md
Outdated
Show resolved
Hide resolved
.ai/skills/write-review-translate-release-notes/references/compatibility-changes.md
Outdated
Show resolved
Hide resolved
.ai/skills/write-review-translate-release-notes/references/bilingual-alignment.md
Outdated
Show resolved
Hide resolved
[LGTM Timeline notifier]Timeline:
|
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
/retest |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Oreoxmt 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 |
2 participants
First-time contributors' checklist
What is changed, added or deleted? (Required)
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?