1.9 KiB
Notes for AI coding agents
Start with docs/workflow.md: what to work on first (severity x reach x confidence, reach from the hardware people run), the hardware tiers a change must not break, and the steps from claim to release. The open work, scored and sorted, is in docs/worklist.md: pick from its top.
Follow CONTRIBUTING.md: its rules apply to agents as to everyone, above all that no game files or anything made from them leave the PC. The development guide has the layout and the commands; the design notes have the architecture and the rules the GPU replay keeps.
What CONTRIBUTING.md does not spell out, and agents trip on:
- Tests read the source. Many checks in
tests/cut a function out of a source file by its text and compile it with stubs (17 readgpu/vk/vk_menu.cppalone). Renaming or reshaping a function can break a check far from your change: runpython -I -B tests/run_all.pyand update the check in the same PR rather than weakening it. - The renderer's interface is versioned. A change to
MkwVkHostorMkwVkRendereringpu/vk/vk_api.hbumpsMKWVK_API_VERSION. - Generated files are generated. The SPIR-V headers in
gpu/vk/shaders/(*_spv.h) are compiled from the shader beside them; regenerate them with glslang rather than editing them (the shaders' tests show the command). - Two platforms. Windows builds with llvm-mingw, Linux with clang/gcc. Keep host code portable, and paths UTF-8
(no
CP_ACP;tests/test_utf8_paths.py). - No game in CI. Checks must run without a dump. A run in the game is for you to do locally and report.
Pull requests: open the description with why the PR is needed, in one or two plain sentences, and include screenshots when the change shows on screen (CONTRIBUTING.md, Commits and pull requests).