feat(prs): one ready-for-review list: tested on your own PC, or what can't be run by hand said; two new Everyone boxes #1454
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!1454
Loading…
Reference in a new issue
No description provided.
Delete branch "HumanBean/Longshot:docs/ready-for-review"
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: feat · Risk: low · Tested on: Linux (the checker through
forge.py pr status) · Needs: noneWhy
What a pull request needs before it leaves WIP was spread over six places: the template's opening comment, CONTRIBUTING.md's step 4, docs/agent-pull-requests.md, docs/workflow.md, and Tooling's AGENTS.md and docs/forge.md. Each said it a little differently, and none said the author must have run the change on their own PC. PRs went to review with only a game-free check behind them, or with "not tested" and no reason. A fix whose own case can't be run by hand (hardware you don't have, a race you can't trigger) had no place to say so.
What changed
CONTRIBUTING.md has one list, Ready for review: out of WIP, and everything else points to it. Its central rule: you tested the change on your own PC (in the game, for a change the game runs). Other hardware is not needed to leave WIP; when the fix's own case can't be run by hand, Testing says so in a part of its own.
CONTRIBUTING.md: the new section's seven points:main.It also says what is not needed: runs on other hardware, a Test Farm result, an approval. Step 4 now links to the list instead of restating part of it.
.forgejo/pull_request_template.md:scripts/check_pr_description.py:UNTESTABLE, Testing's optional part. It is read as a part of its own, so a Not testable by hand line written after Must be tested isn't taken for one of its items. Kept but empty, it is a problem.docs/agent-pull-requests.md,docs/workflow.md: link to the list. An agent that only can't run the fix's own case runs the rest and says so in Not testable by hand.tests/test_check_pr_description.py,tests/pr_description/good.md: the two new boxes in the sample; the template's unticked count 10 to 12; the new part filled in, after Must be tested, and empty.Tooling's shared rules get the same list in short: MagicBeanDev/Tooling#20.
Measurements
Verdict: nothing to measure: rules, the template and the description checker, which the game doesn't run.
Flags and settings
None.
Testing
Tested: on this PC (Linux),
forge.py pr statuson this pull request from this branch's checkout, which loads this branch'sscripts/check_pr_description.py(results in the first comment). The test file was read against the checker by hand, not run.Not tested:
python -I -B tests/run_all.py, including the updatedtests/test_check_pr_description.py: not run on this PC (the person I work for runs no test suites here); CI's Python source checks run it on this PR.Must be tested: None
Risks
What could break: every open pull request made from the old template lacks the two new Everyone boxes, so
pr ready(and the PR description check) lists them as missing until its author adds and ticks them. That is the point, but it touches every open PR once. A description whose Testing has a line starting "Not testable by hand" is now read as that part.Turning it off: revert the commit.
Compatibility: Nothing changes for players.
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: waiting for CI's Python source checks.third_party/untouched (a new folder with aPROVENANCE.mdinstead).When it applies
Assisted-by:/Co-Authored-By:trailers.tests/that reads changed source updated in this PR, not weakened.🤖 Generated with Claude Code
Possibly related, for context:
Run on this PC (Linux), from this branch's checkout:
forge.py pr status 1454loads this branch's checker and counts 12 Everyone boxes, flagging only the run_all box left open.scripts/check_pr_description.py --fileon this description with that box ticked and a filled Not testable by hand: line after Must be tested: complete, exit 0 (the line is not read as a Must be tested item). The same with the line empty: exit 1, "## Testing's 'Not testable by hand:' is empty: say what can't be run by hand and why, or delete it". tests/run_all.py not run here: waiting for CI.Marked ready and force-merged at the request of the person I work for, before a pass that brings the open PRs to this standard. tests/run_all.py has not run on this change: CI skipped its Python source checks, and it isn't run on this PC. The Guide screenshots check fails on main itself since #1362, not from this PR.
WIP: feat(prs): one ready-for-review list: tested on your own PC, or what can't be run by hand said; two new Everyone boxesto feat(prs): one ready-for-review list: tested on your own PC, or what can't be run by hand said; two new Everyone boxes2d2bcd8ec2950e042cc2LONGSHOT_JOBSfiles at once, not one #1147