Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (52 loc) · 4.78 KB

CONTRIBUTING.md

File metadata and controls

77 lines (52 loc) · 4.78 KB
Raw

Contributing to MouseDrive

Thanks for your interest in MouseDrive! Bug reports, game setups, ideas and code are all welcome. Issues and discussions can be written in English or Turkish.

Ways to help

You want to… Go to
Report a bug New issue → Bug report
Ask a question or get setup help Discussions → Q&A
Suggest a feature Discussions → Ideas
Share settings for a game or car Discussions
Report a security issue SECURITY.md — never in a public issue
Change code or docs A pull request (see below)

For anything larger than a small fix, please start a discussion or comment on the issue first, so we can agree on the approach before you spend time on it.

How this repository works

The public repository holds the source code every release is built from. Development happens on the maintainer's private branch, which also holds the test suite and developer tools; each release is exported from it with most code comments removed.

What this means for you:

  • Pull requests are reviewed and merged here as usual. The maintainer then carries the change over to the development branch, with you as the author, so later exports keep it.
  • The internal tests are not public. Please describe in your pull request how you tested the change: operating system, game and steps, plus the vJoy version on Windows or the distribution and session (X11 or Wayland) on Linux.
  • Please do not edit CHANGELOG.md; the maintainer writes the entries when preparing a release.

Building

rust-toolchain.toml pins the Rust toolchain; rustup installs it on the first cargo call.

  • Windows: Windows 10/11 with the MSVC toolchain. To run MouseDrive you need the vJoy driver.
  • Linux: x86-64. To run MouseDrive you need glibc 2.35 or newer, an X11 or Wayland desktop session, the uinput module and the one-time Linux setup. Run it as your normal user, never with sudo.

The commands are the same on both systems:

cargo build --release --manifest-path MouseDrive/Cargo.toml
# without the auto-updater (no network code)
cargo build --release --manifest-path MouseDrive/Cargo.toml --no-default-features

Before opening a pull request, run the checks CI runs on Windows and Linux:

cargo fmt --manifest-path MouseDrive/Cargo.toml --check
cargo clippy --locked --manifest-path MouseDrive/Cargo.toml --all-targets --all-features -- -D warnings
cargo clippy --locked --manifest-path MouseDrive/Cargo.toml --all-targets --no-default-features -- -D warnings

On Linux, CI also runs cargo deny and checks the files in packaging/; the README's Build section lists those commands. The README's Project layout section explains what lives where.

Code guidelines

Source paths below are relative to MouseDrive/src/ in the MouseDrive repository.

  • Format with rustfmt; clippy must pass with -D warnings in both feature sets.
  • No unwrap() / expect() outside tests. Handle the error and tell the user what happened and what to do; MouseDrive has no silent fallbacks.
  • Every unsafe block needs a // SAFETY: comment that states why it is sound.
  • The driving logic (logic.rs, logic/) stays pure: no Windows or Linux API calls and no clock reads; time comes in through the tick input.
  • The control loop (control/) runs at 250 Hz: no blocking calls, file I/O or logging per tick.
  • Every user-visible string goes into both lang/en.rs and lang/tr.rs.
  • Keep dependencies few; discuss a new one before adding it. Network code belongs only to the updater feature.
  • One logical change per pull request; keep refactors separate from behaviour changes.

Commits and sign-off

  • Short, imperative subjects with a type prefix: feat:, fix:, docs:, refactor:, perf:, build:, ci:, chore:.
  • Sign off every commit (git commit -s). The Signed-off-by: Your Name <email> line certifies that you wrote the change or have the right to submit it, as described in the Developer Certificate of Origin 1.1.

License

MouseDrive is licensed under GPL-3.0-or-later. Contributions are accepted under the same license, and you keep the copyright of your work. The license grants no rights to the MouseDrive name or logo.

Code of conduct

Everyone taking part is expected to follow the Code of Conduct.