Skip to content

Document Versioning3 test flows - #11078

Open
Shivs11 wants to merge 1 commit into
mainfrom
shivam/versioning-3-flow-comments
Open

Document Versioning3 test flows#11078
Shivs11 wants to merge 1 commit into
mainfrom
shivam/versioning-3-flow-comments

Conversation

@Shivs11

@Shivs11 Shivs11 commented Jul 15, 2026

Copy link
Copy Markdown
Member

What changed

  • Add numbered Flow: comments to the three explicit pinned child override tests.
  • Record the tests/versioning_3_test.go flow-comment convention in AGENTS.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 --check
  • Adversarial review accepted with no findings
  • Tests not run because the change only adds comments and repository guidance

Note

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.md now requires new or updated tests in tests/versioning_3_test.go to include a concise numbered Flow: 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.

Comment thread AGENTS.md
## 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

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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?

@stephanos stephanos Jul 15, 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.

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
Shivs11 marked this pull request as ready for review July 15, 2026 12:36
@Shivs11
Shivs11 requested review from a team as code owners July 15, 2026 12:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants