Repository navigation
docs: PR review rules — the version bump becomes a calculation - #73
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #73 +/- ##
=========================================
Coverage 98.27% 98.27%
Complexity 1043 1043
=========================================
Files 123 123
Lines 2606 2606
Branches 301 301
=========================================
Hits 2561 2561
Partials 45 45 Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
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.
What
Adds
.github/code-review/REVIEW.md: the standing instructions the PR reviewbot reads for this repository. The file opens with
@include default, so theserules sit on top of the shipped defaults rather than replacing them.
Generated from
docs/sdk/inMarketData-App/code-review-bot. Edit it there andregenerate, so the shared part cannot drift across the six SDKs.
The rule this exists for
A non-breaking change takes the next minor, a breaking change takes the next
major, and each SDK decides on its own — the same API change can break
Java's
dte(String)and leave Python's dynamic signature untouched.The reviewer does not form an opinion about whether a change is breaking. It
compares the public surface before and after, reports the table as evidence, and
applies a mechanical test: a public symbol that disappeared or a type that
changed is breaking. The bump becomes a calculation, which is what stops a
major shipping by accident.
Two questions that both get called "breaking" are kept apart: whether the API
change is breaking (one answer for every SDK, from the schema diff, decided
upstream) against whether a pull request breaks this SDK's public surface (the
reviewer's question, and the one that sets the bump).
Also in the file
heading, a migration line, and the version impact stated in the description
capability, not the subset the author needed
so a fix to shared logic says whether the siblings have it
token is blocking because it reports success while testing nothing
Version impact
none. Documentation for the review bot. No source file changes, no release.