AGENTS.md: Update PR title and description guidelines by lance6716 · Pull Request #64477 · pingcap/tidb

lance6716 · 2025-11-13T13:23:09Z

What problem does this PR solve?

Issue Number: ref #63847

Problem Summary:

What changed and how does it work?

#64328 (comment) this can let copilot file a PR that directly pass CI test check

Check List

Tests

Unit test
Integration test
Manual test (add detailed scripts or steps below)
No need to test
- I checked and no code files have been changed.

Side effects

Performance regression: Consumes more CPU
Performance regression: Consumes more Memory
Breaking backward compatibility

Documentation

Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

None

Clarify PR title and description formatting requirements.

tiprow · 2025-11-13T13:23:23Z

Hi @lance6716. Thanks for your PR.

PRs from untrusted users cannot be marked as trusted with /ok-to-test in this repo meaning untrusted PR authors can never trigger tests themselves. Collaborators can still trigger tests on the PR using /test all.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

lance6716 · 2025-11-13T13:26:46Z

/ok-to-test
/cc @wuhuizuo @hawkingrei @D3Hunter

hawkingrei · 2025-11-13T14:49:59Z


 **Format 2 (Repository-Wide):** `*: what is changed`

-The PR description **must** strictly follow the template located at @.github/pull_request_template.md. **Do not remove, alter, or modify** any HTML comments (`<!--`, `-->`) within the template. These elements are essential for CI and removing them will cause processing failures.


Because GitHub uses Copilot, which has its own prompt file.

https://docs.github.com/en/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review#example

https://docs.github.com/en/copilot/how-tos/use-copilot-agents/request-a-code-review/configure-automatic-review

I want to use copilot write codes, rather than do code review. However I remember there's also a dedicated file for copilot coding agent, I'll take a look tomorrow.

/unhold

I use a new file according to https://docs.github.com/en/enterprise-cloud@latest/copilot/tutorials/coding-agent/get-the-best-results#adding-custom-instructions-to-your-repository for copilot coding agent

lance6716

/hold

move copilot instrunctions to the separate file.

Clarify requirements for PR description and issue usage

Copilot

Pull Request Overview

This PR updates the PR title and description guidelines in AGENTS.md to provide clearer instructions for AI agents like Copilot when creating pull requests. The changes improve clarity around formatting requirements and add a new instruction file specifically for Copilot.

Restructured PR instructions section with clearer subsection headers
Clarified when to use * in PR titles (non-package-specific or too many packages)
Simplified PR description requirements to focus on HTML comment preservation
Added Copilot-specific instructions for handling issue number references

Reviewed Changes

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

File	Description
AGENTS.md	Reorganizes PR instructions with subsection headers and clarifies PR title/description guidelines
.github/copilot-instructions.md	Adds new Copilot-specific instruction about using issue numbers in PR descriptions

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

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

ti-chi-bot · 2025-11-14T05:28:27Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: D3Hunter, hawkingrei

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:

~~OWNERS~~ [D3Hunter,hawkingrei]

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 · 2025-11-14T05:28:30Z

[LGTM Timeline notifier]

Timeline:

2025-11-13 14:52:54.666526466 +0000 UTC m=+973024.109556335: ☑️ agreed by D3Hunter.
2025-11-14 05:28:29.864260032 +0000 UTC m=+1025559.307289911: ☑️ agreed by hawkingrei.

Copilot

Pull Request Overview

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

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

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

lance6716 · 2025-11-14T08:16:34Z

/retest

Update PR title and description guidelines

40e7eb0

Clarify PR title and description formatting requirements.

ti-chi-bot Bot added release-note-none Denotes a PR that doesn't merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 13, 2025

Update AGENTS.md

443f812

ti-chi-bot Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 13, 2025

ti-chi-bot Bot requested a review from D3Hunter November 13, 2025 13:26

ti-chi-bot Bot added the ok-to-test Indicates a PR is ready to be tested. label Nov 13, 2025

ti-chi-bot Bot requested review from hawkingrei and wuhuizuo November 13, 2025 13:26

hawkingrei reviewed Nov 13, 2025

View reviewed changes

D3Hunter approved these changes Nov 13, 2025

View reviewed changes

ti-chi-bot Bot added needs-1-more-lgtm Indicates a PR needs 1 more LGTM. approved labels Nov 13, 2025

lance6716 commented Nov 13, 2025

View reviewed changes

ti-chi-bot Bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 13, 2025

lance6716 added 2 commits November 14, 2025 09:36

Create copilot-instructions.md

3f4f43d

Update PR description guidelines in AGENTS.md

25344f9

Clarify requirements for PR description and issue usage

ti-chi-bot Bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 14, 2025

hawkingrei requested a review from Copilot November 14, 2025 03:52

Copilot started reviewing on behalf of hawkingrei November 14, 2025 03:53 View session

Copilot finished reviewing on behalf of hawkingrei November 14, 2025 03:54

Copilot AI reviewed Nov 14, 2025

View reviewed changes

Comment thread AGENTS.md Outdated

Comment thread .github/copilot-instructions.md Outdated

lance6716 and others added 2 commits November 14, 2025 12:13

Update AGENTS.md

d83f885

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update .github/copilot-instructions.md

0c315e1

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

hawkingrei requested review from Copilot and hawkingrei November 14, 2025 05:27

Copilot started reviewing on behalf of hawkingrei November 14, 2025 05:27 View session

hawkingrei approved these changes Nov 14, 2025

View reviewed changes

ti-chi-bot Bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Nov 14, 2025

Copilot finished reviewing on behalf of hawkingrei November 14, 2025 05:28

Copilot AI reviewed Nov 14, 2025

View reviewed changes

Comment thread AGENTS.md Outdated

Comment thread AGENTS.md Outdated

Update AGENTS.md

647dc6d

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

ti-chi-bot Bot merged commit 52f78e9 into master Nov 14, 2025
5 checks passed

ti-chi-bot Bot deleted the lance6716-patch-1 branch November 14, 2025 08:19


		Format 2 (Repository-Wide): `*: what is changed`

		The PR description must strictly follow the template located at @.github/pull_request_template.md. Do not remove, alter, or modify any HTML comments (`<!--`, `-->`) within the template. These elements are essential for CI and removing them will cause processing failures.

Uh oh!

Conversation

lance6716 commented Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What problem does this PR solve?

What changed and how does it work?

Check List

Release note

Uh oh!

tiprow Bot commented Nov 13, 2025

Uh oh!

lance6716 commented Nov 13, 2025

Uh oh!

hawkingrei Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

hawkingrei Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

hawkingrei Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

lance6716 Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

lance6716 Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

lance6716 left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

ti-chi-bot Bot commented Nov 14, 2025

Uh oh!

ti-chi-bot Bot commented Nov 14, 2025

[LGTM Timeline notifier]

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

lance6716 commented Nov 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

lance6716 commented Nov 13, 2025 •

edited

Loading