Skip to content

ai: add docs-pr-metadata-guard and docs-issue-metadata-guard skills#23051

Merged
ti-chi-bot[bot] merged 4 commits into
pingcap:masterfrom
qiancai:add-pr-metadata-guard
Jun 12, 2026
Merged

ai: add docs-pr-metadata-guard and docs-issue-metadata-guard skills#23051
ti-chi-bot[bot] merged 4 commits into
pingcap:masterfrom
qiancai:add-pr-metadata-guard

Conversation

@qiancai

@qiancai qiancai commented Jun 12, 2026

Copy link
Copy Markdown
Collaborator

What is changed, added or deleted? (Required)

Add two new AI agent skills under .ai/skills/ and register them in AGENTS.md and .ai/AI-README.md:

  • docs-pr-metadata-guard: guides AI agents to preserve the PR template structure when creating or editing pull requests — including version checkboxes, required description sections, HTML comments, related-link fields, base branch selection, cherry-pick label conventions, and the first-time contributors' checklist.
  • docs-issue-metadata-guard: guides AI agents to use the correct issue template (Error Report, Change Request, or Question) when creating or editing issues — including required fields, docs-only scope enforcement, template structure preservation, and label hygiene.

Why these skills are needed:

When human contributors create PRs or issues through the GitHub web UI, the repository templates are pre-loaded automatically, so the required structure is naturally followed. However, when AI agents create PRs or issues via the gh CLI, these templates are not enforced — the agent can easily skip the template entirely, produce a freeform body, omit version checkboxes, or ignore required fields. These two skills close that gap by giving agents explicit instructions to read and follow the repository templates before calling gh, ensuring agent-created PRs and issues meet the same structural standards as human-created ones.

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/L Denotes a PR that changes 100-499 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 introduces two new AI skills, docs-pr-metadata-guard and docs-issue-metadata-guard, and updates .ai/AI-README.md and AGENTS.md to document them. These skills guide the preservation of template structures, required fields, and metadata conventions for pull requests and issues. The review feedback points out several headings in the new skill files that violate the repository style guide requiring sentence case.

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.

Comment thread .ai/skills/docs-issue-metadata-guard/SKILL.md
Comment thread .ai/skills/docs-issue-metadata-guard/SKILL.md Outdated
Comment thread .ai/skills/docs-issue-metadata-guard/SKILL.md Outdated
Comment thread .ai/skills/docs-issue-metadata-guard/SKILL.md Outdated
Comment thread .ai/skills/docs-issue-metadata-guard/SKILL.md Outdated
Comment thread .ai/skills/docs-issue-metadata-guard/SKILL.md Outdated
Comment thread .ai/skills/docs-pr-metadata-guard/SKILL.md
Comment thread .ai/skills/docs-pr-metadata-guard/SKILL.md Outdated
Comment thread .ai/skills/docs-pr-metadata-guard/SKILL.md Outdated
Comment thread .ai/skills/docs-pr-metadata-guard/SKILL.md Outdated
Comment thread .ai/AI-README.md Outdated
qiancai and others added 2 commits June 12, 2026 10:16
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@qiancai qiancai self-assigned this Jun 12, 2026
@qiancai qiancai added the translation/no-need No need to translate this PR. label Jun 12, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. 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 02:26:46.535700113 +0000 UTC m=+1099707.606017503: ☑️ agreed by lilin90.

@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jun 12, 2026
@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 912b57a into pingcap:master Jun 12, 2026
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants