Thanks for looking. RageKit is experimental, so open an issue before a large change: the design may already be moving.
Working with an AI coding agent? Point it at AGENTS.md.
./setup.sh # Linux; setup.ps1 on WindowsThat installs the CLI's Composer dependencies, the pinned toolchain (TypePHP and Slint, shared
per user, or into .ragekit/ if the repository root has one) and runs ragekit doctor. See
docs/toolchain.md.
vendor/bin/phpunitThe suite needs the toolchain from ragekit setup (some tests build C++ and run the dev shell
headless) and PHP's mbstring extension. Window-level checks of the demos run under Xvfb; see
tests/e2e/README.md.
CI (.github/workflows/ci.yml) runs on every push and pull request, on Ubuntu 24.04:
ragekit setup, ragekit doctor, the test suite, then a Nano and a normal build of every demo
(the normal ones link Ubuntu's libphp8.4-embed), each started and closed under Xvfb
(tests/e2e/demos.sh). Windows and macOS aren't covered.
Every change comes with a test that fails without it. Bug fixes start with a test that reproduces the bug.
src/Cli/is theragekitcommand. It runs on the developer's PHP and must work on PHP 8.2.- PHP that ends up in apps (
src/*.php,src/Slint/*.php, modules'src/) is compiled by TypePHP, which accepts a subset of PHP. In particular: everyswitchcase ends withbreak/return/continue/throw; functions from.stub.phpfiles are called fully qualified (\slint_open()); noabstract staticmethods; no class namedBox. - C++ in
native/and modules: the host is C++17 (Nano builds require it), the bridge and dev shell are C++20 (Slint requires it). Only the bridge calls Slint or the OS. - Keep claims precise: RageKit draws its own widgets and its executables contain PHP's runtime (a stripped-down one in Nano builds). Don't describe it as "native widgets" or "no PHP runtime".
Small, focused commits with a message that says why. A pull request describes what changed, how you tested it, and on which OS.
By contributing you agree that your contribution is licensed under the GPLv3, like the rest of RageKit. You also allow the project's maintainer to license your contribution under other open source licenses in future versions (for example to let apps built with RageKit use any license). Versions already released keep their license.