Skip to content

Improve PR instructions for agents #8412

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
gonzaloriestra merged 2 commits into from
Sep 9, 2026
+11 −1
Merged

Improve PR instructions for agents #8412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55c88dc
Improve PR instructions for agents
gonzaloriestra Aug 27, 2026
4c77815
Improve "Be concise" instruction
gonzaloriestra Sep 9, 2026
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: 2 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@ Fixes #0000 <!-- link to issue if one exists -->
Before / after screenshots appreciated for UI changes.
-->

### How to test your changes?
### How to manually test your changes?

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

@amcaplan amcaplan Sep 9, 2026

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!

You can post a comment with `/snapit` to generate a snapshot of the changes to be tested.
-->

Expand Down
9 changes: 9 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,15 @@ Adhere to the following guidelines in your code:
- In tests, always avoid mocking the filesystem. Use real files and directories, in temporary directories if needed.
- In tests, prefer to have as little shared state between tests as possible. Avoid beforeAll and afterAll.

### PR creation

- Use GitHub stacks for multiple dependant PRs.
- Follow the template from .github/PULL_REQUEST_TEMPLATE.md.
- Write a concise description, explaining the problem and the high-level approach. Include implementation details only when they help reviewers understand a decision or tradeoff. Avoid repeating what is clear from the diff. Example for the WHAT section: "Refresh expired credentials before retrying the requests, so users can continue without signing in again".
- Remove empty sections and hidden comments.
- Do not mark checklist items as completed (except the changelog one if added).
- In "How to test your changes?" only include CLI commands to test locally, do not add commands to run tests or other checks.

## Changesets

Add a changeset only when the change is user-facing and ready to appear in public changelogs and release notes.
Expand Down
Loading