From 093360207620f98369a0a4a3332eec2e4386e7e6 Mon Sep 17 00:00:00 2001 From: "Michael S." Date: Mon, 25 May 2026 13:10:34 +0200 Subject: [PATCH] Add CONTRIBUTING.md: branch -> PR -> merge workflow --- CONTRIBUTING.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b2fa705 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +# Contributing to glogout + +Thanks for your interest in glogout! A few conventions keep the project tidy. + +## Branch → PR → merge + +**`main` is protected — no direct pushes.** All changes, including the +maintainer's, go through a pull request: + +```bash +git switch -c my-change # branch off main +# ...make your changes, commit them... +git push -u origin my-change +gh pr create # or open the PR in the GitHub UI +``` + +A PR can be merged into `main` once the **`build (release)`** CI check passes. +This applies to solo work too — the PR is the review checkpoint and keeps the +public history clean. + +## Building locally + +```bash +cargo build --release +``` + +You'll need the system libraries listed under **Requirements** in the +[README](README.md): GTK 4.14+, `gtk4-layer-shell`, and WebKitGTK 6.0. + +## Scope + +glogout targets Wayland compositors implementing `wlr-layer-shell` (validated on +Hyprland). See the README for supported-compositor details and known +limitations before filing a bug.