Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 2.74 KB

File metadata and controls

26 lines (21 loc) · 2.74 KB

Repository guidance

Project audits, implementation research, release handoffs, and technical roadmaps live in docs/. Read the relevant documents there before changing the corresponding subsystem, and update them when new evidence changes a recorded conclusion.

Start with:

Documentation rules:

  • Keep README.md at the repository root as the user-facing project entry point.
  • Keep subsystem-owned README.md, CONTRIBUTING.md, and provenance files beside the code they describe; the docs/ rule applies to repository-level research and handoffs.
  • Put new research and handoff Markdown in docs/, not in the repository root.
  • Record the commit, date, exact reproduction commands, and source path/line evidence for audits and measurements.
  • Separate shipped behavior, historical measurements, proposed work, and unverified assumptions.
  • Do not describe the integrated C++ launcher as packaged or shipped yet: commit 514cd424 is a source-tree prototype, while the Windows ZIP and Linux AppImage still use their existing wrapper and script setup paths.
  • Do not describe current netplay as rollback: the audited implementation is fixed-delay lockstep. Rollback exists only as experimental state/replay groundwork until the live protocol gains prediction, snapshots, correction, and resimulation.