Skip to content

Improve PR instructions for agents - #8412

Merged
gonzaloriestra merged 2 commits into
mainfrom
improve-pr-instructions
Sep 9, 2026
Merged

Improve PR instructions for agents#8412
gonzaloriestra merged 2 commits into
mainfrom
improve-pr-instructions

Conversation

@gonzaloriestra

Copy link
Copy Markdown
Contributor

WHY are these changes introduced?

PRs created by agents are usually too verbose and inconsistent.

WHAT is this pull request doing?

Improve AGENTS.md instructions to follow the template and be more consistent

How to test your changes?

Merge and create PRs

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes
  • I've considered analytics changes to measure impact
  • The change is user-facing — I've identified the correct bump type (patch for bug fixes · minor for new features · major for breaking changes) and added a changeset with pnpm changeset add

@gonzaloriestra
gonzaloriestra requested a review from a team as a code owner August 27, 2026 08:22
@github-actions github-actions Bot added the no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users. label Aug 27, 2026
@gonzaloriestra
gonzaloriestra force-pushed the improve-pr-instructions branch from 7446487 to c2d9c12 Compare August 31, 2026 12:58

@craigmichaelmartin craigmichaelmartin 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.

Thanks!


<!--
Please, provide steps for the reviewer to test your changes locally.
Do not include here commands to run tests or other checks, automated CI will run them.

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.

Excellent point. This always bothers me!

Comment thread AGENTS.md Outdated

- Use GitHub stacks for multiple dependant PRs
- Follow the template from .github/PULL_REQUEST_TEMPLATE.md
- Be concise

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.

This one line might be a bit too concise - maybe some "focus on X, not Y" might help.

Still an improvement, I guess we'll see if it's enough.

But I think saying to keep it short is more likely to lead to trying to squeeze more meaning into fewer words rather than really evaluating what needs to be present.

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.

I second this one. Examples might be helpful here as well.

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.

Updated! Better now?

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.

I'd say so, thanks @gonzaloriestra!

Comment thread AGENTS.md Outdated

- Use GitHub stacks for multiple dependant PRs
- Follow the template from .github/PULL_REQUEST_TEMPLATE.md
- Be concise

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.

I second this one. Examples might be helpful here as well.

@gonzaloriestra
gonzaloriestra force-pushed the improve-pr-instructions branch from d7de83b to 4c77815 Compare September 9, 2026 14:47
@gonzaloriestra
gonzaloriestra added this pull request to the merge queue Sep 9, 2026
Merged via the queue into main with commit 409870d Sep 9, 2026
30 checks passed
@gonzaloriestra
gonzaloriestra deleted the improve-pr-instructions branch September 9, 2026 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog This PR doesn't include a changeset entry. Is an internal only change not relevant to end users.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants