mirror of
https://github.com/wayvr-org/wayvr.git
synced 2026-11-20 00:51:19 -08:00
47 lines
1.3 KiB
Markdown
47 lines
1.3 KiB
Markdown
# Contributing
|
|
|
|
Contributions are warmly welcome. Before you start, please read the entire document carefully.
|
|
|
|
## AI Policy
|
|
|
|
Do not use LLMs to generate substantial pieces of code. You need to fully understand every line of code you change. No exceptions.
|
|
|
|
Commits, issues and pull requests must be made by humans. Co-authoring by AI is not allowed.
|
|
Looking to create an issue on the project, such as a feature request or bug report? Focus on writing what you know for sure in simple terms. We'll figure it out from there.
|
|
|
|
Usage of Gen-AI for visuals and audio is prohibited.
|
|
|
|
The only exception is LLM-translated strings generated by the scripts/translator tool.
|
|
|
|
## Basics
|
|
|
|
Before committing, make sure to format your Rust code by running:
|
|
|
|
```
|
|
cargo fmt
|
|
```
|
|
|
|
You should also check for any compiler warnings too:
|
|
|
|
```
|
|
cargo check
|
|
```
|
|
|
|
or even better:
|
|
|
|
```
|
|
cargo clippy
|
|
```
|
|
|
|
## Large contributions
|
|
|
|
If you want to submit a relatively big pull requests, it's highly advisable to create a separate issue request for it. That way we can discuss the approach and sort out the details first.
|
|
|
|
## Adding translations
|
|
|
|
Look at `scripts/translator/run.sh` for more information.
|
|
|
|
## Licensing
|
|
|
|
WayVR is developed and published under [GPL-3 License](https://www.gnu.org/licenses/gpl-3.0.en.html).
|