Contributing
This section is for people working on the engine itself — fixing bugs in a subsystem, adding a lane or an agent, extending the ECS, improving the renderer. If instead you want to build a game on top of Khora, you want the tutorials and the game-side how-to guides — not this section.
Contributing to an engine with a strong architecture (SAA, the CLAD descent, GORNA) means there are conventions you have to internalise before your change will pass review and CI. These pages give you the fastest path to productive, mergeable work.
The path
Follow these in order on your first contribution; come back to any of them as a reference later.
- Set up your environment — clone, build, run the sandbox and the editor, serve the docs. The ordered getting-started that gets a working tree in front of you.
- Take the architecture tour — a guided reading order through the Concepts so you understand the internals fast, in the right sequence, before you touch code.
- Learn the conventions — the hard rules and coding conventions every change must follow (math types, logging, error handling, components, agents, lanes, shaders, the dependency direction).
- Know the workflow — the branch/PR flow and the CI gates your change must pass (format, clippy, the cross-platform test matrix, doctests, supply-chain, MSRV).
When you’re ready to write code
Once you have the lay of the land, the hands-on material lives in two places:
- The Extending the engine tutorial — a guided, end-to-end walk through adding a new piece to the engine.
- The engine-side how-to recipes — task-sized guides for adding a component, a lane, an agent, a shader, an asset decoder, or a flow.
Read those for the how; this section gives you the setup, the map, and the rules that make them stick.