Repository navigation
chore: take the shared review rules from the bot, keep only ours - #109
Merged
Merged
Conversation
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.
The review rules for this SDK now come from the bot, with only this
repository's own rules left here.
What changes
.github/code-review/REVIEW.mdgoes from 192 lines to 30. The sharedSDK rules -- the version-bump calculation, API alignment, the sibling-defect
rule, tests, documentation -- were an inlined copy of a generated file. They
now arrive through
@include sdk, which the bot ships and resolves at reviewtime.
This repository's own text is unchanged, byte for byte. Only the shared
block is removed. The surface section is renumbered 8 to 9, because the shared
rules gained a section 8.
Why
Six hand-maintained copies of the same rules drift. From now on a change to the
shared rules is one pull request in
code-review-bot and none
here. Landed in code-review-bot #15.
The per-language surface rules move the other way -- out of the bot and into
this repository -- because they have exactly one consumer and so there was no
drift for a central copy to prevent.
What the reviewer actually reads
411 lines: the shared default, the shared SDK rules, then this
repository's own section. That is more than before, and the addition is
deliberate -- the shared default gained company-wide review standards
(code-review-bot #17), and the SDK rules gained section 8, "Gotchas: where a
compliant SDK drifts". Those are the traps from the SDK requirements
document where an
ordinary pull request quietly un-implements a requirement: money losing
exactness at the decode step, widening the no-data path past 404, a bulk helper
that writes its own loop instead of using the shared pool, retrying a 4xx.
praiseis also gone from every review (code-review-bot #13).Safety
The bot reads this file from a pull request's base ref, so this takes
effect for pull requests opened after it merges, not for this one.
This repository has no
code-review.ymlcaller workflow yet, so the file does nothing until it is onboarded. It is correct and ready for when it is.