0 Fork 0

mirror of https://github.com/devmobasa/wayscriber.git synced 2026-11-01 07:36:42 +01:00

Files

T

Propose Cargo and GitHub Actions updates, grouping compatible Cargo
bumps. Hold zbus at its current major while ksni requires zbus 5.

2026-10-30 19:25:05 +01:00

AGENTS.md

Scope

Applies to GitHub workflows, issue templates, and repository automation under .github/.

Workflows should mirror local CI and release/package validation.
Release automation depends on version checks, packaging manifests, Nix/package checks, artifact upload, and repository publishing behavior.
ISSUE_TEMPLATE/ uses GitHub issue forms (YAML), not Markdown templates, so reporters get fields instead of a wall of text to edit.

Keep CI aligned with ./tools/lint-and-test.sh.
Issue-form field ids are a public API: https://wayscriber.com/report prefills them by query parameter, and the About dialog in every shipped binary points at that page. Renaming or removing an id silently drops the prefill for binaries that can never be updated retroactively.
Keep Linux system dependencies aligned with real build needs for Wayland, Cairo, Pango, GTK4/libadwaita, D-Bus, packaging, and Nix checks.
deny.toml is the dependency policy and the dependency-policy job enforces it. Advisories report without blocking, so a new advisory cannot fail an unrelated pull request; bans, licenses, and sources block.
dependabot.yml proposes weekly Cargo and GitHub Actions updates. Its zbus major-version ignore is coupled to the advisory ignores in deny.toml.
Do not weaken release checks or skip package layout/version validation without a documented reason.

Workflow dependency changes may require updates to tools/, packaging/, flake.nix, and setup docs.
Release workflow changes may require updates to version scripts and packaging manifests.
Issue-form field ids are coupled with wayscriber-website/report/index.html and with REPORT_URL in src/about_window/content.rs.

Prefer local script validation before changing CI.
For workflow-only edits, run git diff --check and inspect YAML carefully.
After editing an issue form, confirm the prefill contract still holds: issues/new?template=bug_report.yml&diagnostics=hello must show hello in the Diagnostics box.