Skip to content

Contributing

Jason edited this page Aug 11, 2026 · 1 revision

Contributing

Contributions should improve the public source without importing private title material or overstating evidence.

Choose a focused change

  1. Search existing GitHub Issues before opening a new one.
  2. Pick a narrow defect, question, documentation correction, or source-owned fixture.
  3. Read the current source, tests, and maintained documentation for that subsystem.
  4. Keep the branch and pull request focused; make dependencies explicit.
  5. Add or update a regression that exercises the claimed behavior where practical.

Public-safe inputs

Do not commit game binaries, decrypted retail PRXs, generated retail-title C, proprietary assets, private saves/routes, private traces/captures, keys, local filesystem paths, or derived bytes. Source-owned synthetic fixtures are preferred. If a lawful private route is needed for acceptance, describe the evidence boundary without uploading the input.

Tests and review

List exact checks and their evidence category. Use production dispatch when the claim is about a registered PSP operation; label helper, model, and source-shape evidence accurately. Run focused native or Python tests plus the aggregate checks that apply. Keep unresolved acceptance criteria visible even when CI is green.

Preserve the CpuState ABI, generated-code boundary, provenance notices, and fail-closed handling of unknown operations. Prefer general semantic fixes over address-specific workarounds; any unavoidable compatibility override needs evidence, a regression, and a retirement criterion.

Provenance and DCO

Preserve existing SPDX and copyright notices. For new or derived code, record upstream source/revision and translation or reimplementation lineage. AI assistance does not remove review or provenance obligations.

Outside contributors submit commits under the project's documented Developer Certificate of Origin 1.1 policy. Use a deliberate Signed-off-by trailer when required by CONTRIBUTING.md and docs/DCO_POLICY.md. Agents must never invent a human identity or sign off on someone else's behalf.

For security issues, use the private reporting path in SECURITY.md, not a public issue when the private channel is available.

Nakagawa Recomp

Architecture

Development

Project

Research site

Clone this wiki locally