Repository navigation
docs: add API policy and performance review guidance for agents - #27168
Merged
Merged
Conversation
github-actions
Bot
added
the
documentation
mbutrovich
marked this pull request as ready for review
November 6, 2026 17:00
comphead
approved these changes
Nov 6, 2026
comphead
left a comment
comphead
left a comment
Contributor
There was a problem hiding this comment.
Thanks @mbutrovich looks good to me!
alamb
approved these changes
Nov 7, 2026
alamb
left a comment
alamb
left a comment
Contributor
There was a problem hiding this comment.
Thanks @mbutrovich -- I agree this looks like great advice and codifies best practice
| - A PR merges as one squashed commit titled with the PR title, so it should do only what that title says. Put unrelated renames, reformatting, refactors, and drive-by fixes in a | ||
| separate PR. | ||
| - Default to no comment. Comment only what the code cannot say: invariants, non-obvious constraints, and why | ||
| a choice that looks wrong is right. Do not restate the code or describe how it changed. New public items get |
Contributor
There was a problem hiding this comment.
maybe we could suggest adding inline github review comments to describe how it is changed if needed
Contributor
Author
There was a problem hiding this comment.
Good idea, done. The bullet now says to explain a change to reviewers in an inline PR review comment on the changed line.
martin-g
reviewed
Nov 7, 2026
|
|
||
| - A PR merges as one squashed commit titled with the PR title, so it should do only what that title says. Put unrelated renames, reformatting, refactors, and drive-by fixes in a | ||
| separate PR. | ||
| - Default to no comment. Comment only what the code cannot say: invariants, non-obvious constraints, and why |
martin-g
approved these changes
Nov 7, 2026
Omega359
reviewed
Nov 10, 2026
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
Nov 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Rationale for this change
What changes are included in this PR?
What is the testing strategy for this PR?
Are there any user-facing changes?
No.
AI Disclosure
Claude Sonnet helped draft this, but I stand by the content.