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
Section titled “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
Section titled “How to Contribute”-
Create a branch off the latest
main:Terminal window git checkout maingit pull origin maingit checkout -b your-feature-branch -
Make your changes. Match the surrounding code — consistent 2-space indentation, brace-on-same-line,
snake_casenaming, and LPCDoc comment headers on functions. Keep commits focused. -
Open a pull request against
main. Describe what changed and why. -
Review and merge. Once the pull request is reviewed and approved, it is merged into
main.
Before You Submit
Section titled “Before You Submit”- Make sure the code compiles and loads cleanly in the driver.
- If your change touches a documented system, update the relevant page under this wiki.
- Run the unit tests for any area you changed (see the
testingskill and theruntestswizard command).