docs: a pull request is tested in the game and carries its measurements #2712

Closed

github-sync wants to merge 1 commit from github/pr/2712 into main

github-sync commented

2026-11-12 09:31:52 +00:00

Owner

@hckrman101 opened this pull request on GitHub · 2026-11-12 08:41 UTC · original
Merged on GitHub in 8c16c2efb5

Many pull requests arrive tested only by CI, which has no game, and performance changes often come without numbers or with a single run each way. Reviews then have to ask for the run every time.

AGENTS.md now says, under the pull request note: test the change in the game before opening the PR, and put the measurements in the description.

Where it was run and what was seen (area, GPU, driver, OS). If it couldn't be run, say so and open it as a draft.
Performance: before and after on the same scene and otherwise the same build (fps or frame time, the log line it moves, memory where relevant), over several runs or an in-session A/B.
A fix: the log line, screenshot or steps that failed before and pass now.
A new default: the hardware it was measured on, and what it costs where it wasn't.
A row in docs/tested-configurations.md for each measured run.

CONTRIBUTING.md's step 6 says the same in short, for everyone.

Docs only. The checks that read these files pass locally.

> [@hckrman101](https://github.com/hckrman101) opened this pull request on GitHub · 2026-11-12 08:41 UTC · [original](https://github.com/NotRexed/Hookshot/pull/2712) > **Merged on GitHub** in https://git.magicbean.dev/MagicBeanDev/Hookshot/commit/8c16c2efb58dc42a9ff1eee78031fcaafc1dd03e Many pull requests arrive tested only by CI, which has no game, and performance changes often come without numbers or with a single run each way. Reviews then have to ask for the run every time. AGENTS.md now says, under the pull request note: test the change in the game before opening the PR, and put the measurements in the description. - Where it was run and what was seen (area, GPU, driver, OS). If it couldn't be run, say so and open it as a draft. - Performance: before and after on the same scene and otherwise the same build (fps or frame time, the log line it moves, memory where relevant), over several runs or an in-session A/B. - A fix: the log line, screenshot or steps that failed before and pass now. - A new default: the hardware it was measured on, and what it costs where it wasn't. - A row in docs/tested-configurations.md for each measured run. CONTRIBUTING.md's step 6 says the same in short, for everyone. Docs only. The checks that read these files pass locally.

github-sync added 1 commit

2026-11-12 09:31:52 +00:00

docs: a pull request is tested in the game and carries its measurements 1ae12dd946

AGENTS.md and CONTRIBUTING.md: CI has no game, so a PR says where it was run
and what was measured (before and after on the same scene for performance,
the bug gone for a fix, the hardware behind a new default); an untested change
is opened as a draft.

github-sync referenced this pull request from a commit

2026-11-12 09:31:53 +00:00

docs: a pull request is tested in the game and carries its measurements (#2712)

~~github-sync referenced this pull request 2026-11-12 09:32:09 +00:00~~

chore(main): release 2.2.0-rc.1 #2071

github-sync closed this pull request

2026-11-12 09:33:14 +00:00

github-sync referenced this pull request

2026-11-12 10:34:38 +00:00

fix(vk): keep the 97% texture squeeze past the driver's allowance (#2… #2585

~~github-sync referenced this pull request 2026-11-12 11:36:09 +00:00~~

perf(vk): persist pipeline caches without full-size heap copies #2649