Thank you for your interest in contributing to Nitrox! Whether you’re a first-timer or a seasoned developer, we welcome your help.
For significant features, or if you are unsure, contact us on Discord before starting.
🚨 We highly recommend visiting our 📜 documentation, where you will find detailed setup and contribution guides. 🚨
Treat everyone with respect. We value kindness, patience, and constructive feedback. If you encounter inappropriate behavior, please report it to the team.
Please be kind, patient, and constructive. If you disagree, explain your reasoning respectfully and be open to alternatives. Remember that English may not be everyone’s first language, so assume good intent and help each other out.
If you can’t finish something, let us know so others can help.
Please keep our GitHub issues for bug reports and feature requests. For general questions or complaints, please head to our Discord.
If you find a bug, you can help the community by submitting an issue. Once the issue is filed, feel free to work on a fix and submit a PR.
🔍 You can also help us verify issues that are labeled with Status: To Verify.
🏋️ If this is your first time contributing to Nitrox and you do not have advanced programming experience, we have you covered.
Nitrox has a list of good first issues that can be a great way to find something that fits your expertise or technical background.
Nitrox is a special kind of software because it interacts closely with Subnautica's codebase, which makes reliable code generation difficult. That is why you should be careful when using AI tools: they can easily hallucinate when it comes to in-game Nitrox behavior, because they do not understand how the game interacts with Nitrox.
We welcome the use of AI tools (such as Copilot, Codex, etc.) to assist with code or documentation.
🚨 For transparency, you must declare in your pull request if AI tools were used to generate any part of your contribution. This helps reviewers and users understand the origin of the code. Please use the dedicated section in the PR template for this purpose. AI-generated code is allowed, but it must be reviewed and tested by you before submission. 🚨
Anyone can create a Pull Request by forking the Nitrox repository. Once you have made changes in your feature branch, you can open a Pull Request targeting the main branch of the Nitrox repository.
- If you’re unsure where to make changes, ask us on Discord.
- Prefer small PRs for easier review. (As in, one issue per PR)
- Follow code style and review guidelines.
- PRs should be rebased on the latest
main. - Link related issues (e.g.,
Fixes #123). - Test your changes on Windows, Linux, and macOS if possible.
- Ensure your code is clean and reviewed, especially if using AI-generated code.
- Only comment code where the intent is not obvious.
Thank you so much for contributing. Your time and effort are appreciated. Let’s make Nitrox better together!