Skip to content

AGENTS.md: Update PR title and description guidelines #64477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ti-chi-bot merged 7 commits into from
Nov 14, 2025
Merged

AGENTS.md: Update PR title and description guidelines #64477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
40e7eb0
Update PR title and description guidelines
lance6716 Nov 13, 2025
443f812
Update AGENTS.md
lance6716 Nov 13, 2025
3f4f43d
Create copilot-instructions.md
lance6716 Nov 14, 2025
25344f9
Update PR description guidelines in AGENTS.md
lance6716 Nov 14, 2025
d83f885
Update AGENTS.md
lance6716 Nov 14, 2025
0c315e1
Update .github/copilot-instructions.md
lance6716 Nov 14, 2025
647dc6d
Update AGENTS.md
hawkingrei Nov 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
### PR description

If you have an assigned issue, you **must** use the issue number or link to fill the `Issue Number:` line of the pull request template.
8 changes: 6 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,14 @@ If you modify the test set `t/planner/core/binary_plan.test`, then the `TestName

## Pull Request Instructions

The PR title **must** strictly adhere to the following format. It uses the package name(s) affected or `*` if it's a non-package-specific change:
### PR title

The PR title **must** strictly adhere to the following format. It uses the package name(s) affected or `*` if it's a non-package-specific change or too many packages involved:

**Format 1 (Specific Packages):** `pkg [, pkg2, pkg3]: what is changed`

**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.

@hawkingrei hawkingrei Nov 13, 2025

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.

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

@hawkingrei hawkingrei Nov 13, 2025

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.

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

@hawkingrei hawkingrei Nov 13, 2025

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.

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

@lance6716 lance6716 Nov 13, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@lance6716 lance6716 Nov 14, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/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

### PR description

The PR description **must** strictly follow the template located at @.github/pull_request_template.md and **must** keep HTML comment elements in the pull request description according to the pull request template. These elements are essential for CI and removing them will cause processing failures.