Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
21 lines (16 loc) · 971 Bytes

CONTRIBUTING.md

File metadata and controls

21 lines (16 loc) · 971 Bytes
Raw

Contributing to CMAPI

CMAPI targets the complete Windows Steam build of The Planet Crafter. Keep game assemblies, Unity DLLs, native bootstrap binaries, saves, and logs out of commits.

Before opening a change

  1. Sync local references with scripts\Sync-GameReferences.ps1.
  2. Build the full solution in Release mode.
  3. Deploy to a disposable save with scripts\Deploy-Dev.ps1 -SkipBuild.
  4. Run the relevant section of docs\TESTING.md.
  5. Run health_check and include its output with the change.

Public API additions belong in CMAPI.API and must use CMAPI-owned value types, XML summaries, structured failure results, and explicit multiplayer authority. Game types and reflection stay inside the runtime compatibility layer.

Bug reports should use the repository template and include exact CMAPI, Mod Menu, game, and Assembly-CSharp MVID versions. Never attach private saves, Steam invitation codes, or credentials without reviewing the files first.