Contributing

Oxidus is actively maintained on GitHub and contributions are welcome. This page covers the branching model and the workflow for getting a change merged.

Branching Model

The main branch is the stable branch and is protected — only specific users and automated tools push to it directly. All work happens on feature branches cut from main, and changes land back on main through reviewed pull requests.

How to Contribute

1. Create a branch off the latest main:

   git checkout main
   git pull origin main
   git checkout -b your-feature-branch

2. Make your changes. Match the surrounding code — consistent 2-space indentation, brace-on-same-line, snake_case naming, explicit visibility on every function and file-global, and LPCDoc comment headers. Keep commits focused.

   The conventions are written out in full under .claude/skills/ — one directory per topic, each holding a plain-Markdown SKILL.md. Start with lpc-coding-style and lpcdoc; AGENTS.md at the repository root is the condensed form and points at the rest. New source files use the .lpc extension.

3. Open a pull request against main. Describe what changed and why.

4. Review and merge. Once the pull request is reviewed and approved, it is merged into main.

Before You Submit

• Make sure the code compiles and loads cleanly in the driver. A clean compile is not proof of correct behaviour — verify anything behavioural in-game.
• Run the unit tests for any area you changed with the runtests developer command (see the testing skill).
• Use Canadian English in code, comments, strings, and documentation.
• If your change touches a documented system, update the relevant page under this wiki.