docs(agents): mark a PR ready after the update that finishes it, and measure every area a change touches #1715
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
2 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
MagicBeanDev/Longshot!1715
Loading…
Reference in a new issue
No description provided.
Delete branch "HumanBean/Longshot:docs/ready-after-update"
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: n/a (docs only) · Needs: none
TL;DR
Agents are told to mark a pull request ready once it is ready, but only at the moment it first gets there. A PR often becomes ready later, through its last measurement, fix-up or test run, and then sits in work in progress where nobody reviews it. This PR tells agents to check again after each update and mark it ready then. It also says a PR's measurements must cover every area the change touches: the game for a change the game runs, the build's time and size for a build change, load time for a cache change, and several when one change touches several.
Breakdown
pr ready; Complete the applicable evidence gains a bullet listing which numbers each kind of effect needs.Why
Finished PRs get left in WIP when the update that finished them (a last measurement, a fix-up, a run) is not followed by
pr ready. The guide said to mark a PR ready once it is ready, but put that before the update step, so an agent updating a PR had nothing reminding it to check again.PRs also measure only the area they aim at: a compiler flag measured in fps but not in build time, a cache change measured warm but not on first run. CONTRIBUTING.md's Measurements table lists what counts per change type, but not that one change can need several kinds of numbers.
What changed
Two additions to the agents' PR guide:
docs/agent-pull-requests.md, Open and update, thepr updatebullet: after each push, measurement or test run, check again whether the PR is ready and runpr ready <n>then.docs/agent-pull-requests.md, Complete the applicable evidence: a new bullet, "Measure every area the change touches": game (fps, 1% low, frame time), build (time and size), loading and caches (load time, cache size, cold and warm), memory (RAM, VRAM), launcher, tools and scripts; an area that plainly can't be affected gets a line saying so.The same notes go into Tooling's
AGENTS.mdin a companion PR (Tooling #22).Measurements
Verdict: nothing to measure: a docs-only change.
Flags and settings
None
Testing
Tested: read the changed paragraph on the branch; docs only, nothing the game runs.
Not tested:
tests/run_all.pywas not run on this PC (the CI runs it); a docs line in a file no check reads by text.Must be tested:
Risks
What could break: nothing the game runs.
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). Not run on this PC; the CI runs it.third_party/untouched (a new folder with aPROVENANCE.mdinstead).When it applies
Assisted-by:/Co-Authored-By:trailers.🤖 Generated with Claude Code
Possibly related, for context:
74772318fcff4dd3a5a2WIP: docs(agents): check again whether a PR is ready after each updateto WIP: docs(agents): mark a PR ready after the update that finishes it, and measure every area a change touchesAdded a second note in the same commit: measure every area a change touches (game, build time and size, loading and caches, memory, the launcher and tools), not only the one it targets.
WIP: docs(agents): mark a PR ready after the update that finishes it, and measure every area a change touchesto docs(agents): mark a PR ready after the update that finishes it, and measure every area a change touches