Libreqos Rust Workflow
Developmentlibreqos-rust-workflowLibreqos Rust Workflow is an Agent Skill for development published in the LibreQoE/LibreQoS repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Shared LibreQoS Rust workflow for repo contributors. Use when changing Rust under src/rust, validating Rust crates, deciding between workspace commands and --manifest-path, or applying LibreQoS-specific Rust conventions and verification steps.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/LibreQoE/LibreQoS/blob/HEAD/.agents/skills/libreqos-rust-workflow/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/libreqos-rust-workflow, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
LibreQoS Rust Workflow
Use this skill for Rust work in this repo.
Scope
- Rust sources live under
src/rust/. src/rust/Cargo.tomlis the source of truth for current workspace members.- Some crates exist in-tree but are not current workspace members. If a crate is outside
[workspace].members, usecargo --manifest-path path/to/Cargo.toml.
Workflow
- Read
AGENTS.mdfirst for current repo rules and crate descriptions. - Identify whether the touched crate is a workspace member.
- Validate the touched crate with
cargo check -p <crate>when possible. - Run relevant tests.
- Run
cargo clippyfor the touched crate and fix actionable issues. - If dependencies changed, also run:
cargo machetecargo auditcargo tree
- If the change adds, renames, moves, or newly depends on runtime files, static assets, helper scripts, service files, templates, or install-time artifacts, review and update
src/build_dpkg.shin the same change.
Preferred Rust Direction
- Prefer
parking_lotfor newMutexandRwLockusage. - Prefer
crossbeam_channelfor new MPSC/MPMC channels. - Prefer
thiserrorfor structured errors. - Prefer
let elseand early returns over deeply nestedif let. - Avoid introducing new
pub staticvalues with locks when helper functions or actors are better. - Avoid introducing new
#[inline(always)]; prefer#[inline]. - Keep RustDoc current for changed public items and note side effects for non-pure functions.
- Avoid allocation in hot paths.
Notes
- Existing code does not fully match all preferred conventions yet. Treat these as direction for new and touched code, not as a reason to perform unrelated cleanup.
- Build/package scripts live under
src/, not repo root. src/build_dpkg.shis a functional packaging manifest for shipped installs. Forgetting to update it is a common failure mode; treat package-content drift as a bug.- For Insight/LTS2 integrations, preserve the existing external protocol and identity values unless the task explicitly covers coordinated changes on both sides. Unilateral protocol drift is a breaking change.