Repository Guidelines

Project Structure & Module Organization

src/ contains the Rust application code (entry in src/main.rs and modules like src/lockscreen.rs).
tests/ holds integration tests plus shared fixtures in tests/fixtures/ and test data in tests/data/.
data/ packaging metadata; debian/, copr/, and APKBUILD cover distro packaging.
resources/ houses assets that Glib postprocesses into the resulting
build.rs ensures that phrog's schemas are compiled with glib-build-tools and put in ~/.local/share/glib-2.0/schemas.

cargo build builds the greeter (requires libphosh from your distro).
cargo run -- --fake runs without greetd; pair with phoc for Wayland:
- phoc -S -E "cargo run -- --fake"
cargo test runs the test suite; for Wayland-dependent tests:
- phoc -S -E "cargo test"

Rust 2021 edition; toolchain pinned in rust-toolchain.toml.
Format with cargo fmt (rustfmt) and lint with cargo clippy.
Use snake_case for files, functions, and modules; keep modules small and focused.

Integration tests live in tests/ and should be named with snake_case.rs.
Place reusable helpers in tests/common/ and data fixtures in tests/fixtures/.
If a test relies on Wayland/Phosh behavior, document it in the test and use phoc when running locally.

Recent history uses short, scoped subjects like ci/debian: rename. Prefer area: description or area/subarea: description.
PRs should include a concise summary, test results, and screenshots or a short recording for UI changes.
Link related issues when applicable.

phrog is a greetd greeter; packaging in debian/, copr/, and APKBUILD shows how it is wired into services.
Local testing without greetd uses --fake and the default login password 0.