Document Versioning3 test flows - #11078
Open
Shivs11 wants to merge 1 commit into
Open
Conversation
Shivs11
commented
Jul 15, 2026
| ## Testing: | ||
| - Write tests for new functionality | ||
| - Run tests after altering code or tests | ||
| - Tests added to `tests/versioning_3_test.go` must include a concise numbered `Flow:` comment that accurately describes the setup, action, and assertions |
Member
Author
There was a problem hiding this comment.
@stephanos -- personally, i think this should be included for this suite since tests here are quite convoluted/difficult to follow when doing a first pass
an example of a "flow" can be seen in the previous file -- i am tempted to add more suites for this rule, or just make this in general but curious to hear what you think?
Contributor
There was a problem hiding this comment.
No objections; my only suggestion would be to be a little more precise. Unless you've tested it and now it works, I'm not sure these instructions will give you these flow comments you're adding here. For instance, it doesn't mention that they are numbered.
Shivs11
marked this pull request as ready for review
July 15, 2026 12:36
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 changed
Flow:comments to the three explicit pinned child override tests.tests/versioning_3_test.goflow-comment convention inAGENTS.md.Why
These functional tests share setup through a helper, so documenting each scenario's setup, action, and assertions makes the individual test cases easier to review and maintain.
Validation
git diff --checkNote
Low Risk
Comment-only and contributor-guidance changes; no runtime or test logic modified.
Overview
Documents how reviewers should read shared-helper Versioning3 functional tests and codifies that convention for future changes.
AGENTS.mdnow requires new or updated tests intests/versioning_3_test.goto include a concise numberedFlow:comment covering setup, action, and assertions.Three explicit pinned child-override scenarios gain
Flow:blocks: same task queue (pinned parent), cross task queue, and explicit override over an AutoUpgrade parent—each spelling out version registration, parent start behavior, child override, and expected routing/metadata.Reviewed by Cursor Bugbot for commit fbfb31f. Bugbot is set up for automated code reviews on this repo. Configure here.