docs(contributing): a PR's switch carries its recommended value from the first push; measurements gate leaving WIP #1634
No reviewers
Labels
No labels
area/accessibility
area/audio
area/input
area/install
area/menu
area/renderer
area/saves
area/tooling
area/upscaling
beanstalk: approved
beanstalk: failed
beanstalk: needs approval
beanstalk: running
beanstalk: tested
ci: approved
good first issue
gpu/amd
gpu/igpu
gpu/intel
gpu/nvidia
help wanted
kind
bug
kind
chore
kind
docs
kind
feature
kind
performance
kind
question
needs measurements
platform/linux
platform/macos
platform/steam-deck
platform/windows
preview
priority
critical
priority
high
priority
low
regression
risk
high
risk
low
risk
medium
status
blocked
status
confirmed
status
duplicate
status
invalid
status
needs-info
status
wontfix
ci: approved
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
MagicBeanDev/Longshot!1634
Loading…
Reference in a new issue
No description provided.
Delete branch "dyst/Longshot:docs/switch-default-wip"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Type: docs · Risk: low · Tested on: none (docs only) · Needs: none
TL;DR
A new switch for a change meant for players used to stay off in its pull request until the change was measured. But
the Test Farm, testers and the author's own runs test a branch as it is, so they were testing main's behaviour instead
of the change. This makes the rule: the switch carries the value the PR proposes to ship from its first push, and the
measurements decide when the PR leaves work in progress, not when the change turns on.
Breakdown
tests/test_doc_anchors.pypasses (the new link to "Ready for review" resolves).Why
Testers and the Test Farm build a pull request as it is and don't set its switches. With the change off by default
"until measured", their runs said nothing about the change. The maintainers decided the default should be what the PR
proposes to ship, and the evidence should gate leaving WIP instead (the discussion behind #1617, the page bitmap, now
merged on by default).
What changed
The rule in its three places, worded to agree:
CONTRIBUTING.md, Code and data conventions: a switch ships at its recommended value; the PR carries it from itsfirst push, WIP or not; the measurements take it out of WIP; if they go against it, turn the default off or drop the
change before it leaves WIP, and say which.
docs/development.md, Switches for testing and debugging: the same in brief.docs/agent-pull-requests.md, Open and update: the step for agents.Measurements
Verdict: nothing to measure: a docs change.
Flags and settings
None.
Testing
Tested:
python -I -B tests/test_doc_anchors.pypasses on Windows.python -I -B tests/run_all.pyon Windows: 576 passed, 69 failed, every failure also onmain35a4a9fcon this PC (test_prepare_cache_savefails there too;test_texture_tile_uploadfailed under load and passes alone). No game run: the change is docs only.Not tested: nothing the game runs is changed.
Must be tested:
Risks
What could break: nothing in the game; the rule asks more of a WIP author whose measurements go against the change (turn it off or drop it before leaving WIP).
Turning it off: revert the commit.
Compatibility: Nothing changes.
Checklist
Everyone
type(scope): description) of the status line's type.can't be run by hand is in Testing's Not testable by hand, with why.
in Risks.
main.python -I -B tests/run_all.pypasses (any failure that also fails onmainis named).third_party/untouched (a new folder with aPROVENANCE.mdinstead).When it applies
Assisted-by:/Co-Authored-By:trailers.🤖 Generated with Claude Code