Contributing

Contributing

Thanks for helping HyperHLE! Quick orientation; the repo's CONTRIBUTING.md and dev-docs/ have the full story.

Repo setup

git clone https://github.com/KlugKlugTG/HyperHLE-Fork
cd HyperHLE-Fork
git submodule update --init
RUSTFLAGS="-C link-arg=-latomic" cargo build --release   # -latomic needed on many Linux setups

See Build and CI for platform prerequisites (Boost, CMake, SDK/NDK for Android).

Before opening a PR

RUSTFLAGS="-C link-arg=-latomic" cargo test -- --skip test_app
dev-scripts/lint.sh      # comment-length + clippy + cargo doc (note: trunk has pre-existing clippy warnings on Rust 1.95+)
dev-scripts/format.sh    # needs clang-format for submodule C/C++

What to work on

• Implementing missing frameworks APIs — find candidates with dev-scripts/log-unimplemented.sh app.app (Debugging) or via AppDB reports.
• GLES/Core Animation rendering fixes.
• Android-side improvements under android/.

Ground rules

• MPL 2.0 for all code; keep the clean-room policy described in the README (no copying from upstream's GerritHub).
• Comment-length and style checks are enforced by lint; run it locally.
• cargo doc-friendly comments are appreciated — the codebase is extensively documented that way.