Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows
Add system docstring guideline and CLAUDE.md compliance review (#1867)
Maximilian Roosb96ec53ae675
diff --git a/.claude/skills/running-tend/references/review-pr.md b/.claude/skills/running-tend/references/review-pr.mdindex b2bca3965..874f4fe8a 100644--- a/.claude/skills/running-tend/references/review-pr.md+++ b/.claude/skills/running-tend/references/review-pr.md@@ -6,8 +6,6 @@- Does the code follow Rust idioms? (Iterator chains over manual loops, `?` overmatch-on-error, proper use of Option/Result, etc.)-- Does it follow the project's conventions documented in CLAUDE.md? (Cmd for- shell commands, error handling with anyhow, accessor naming conventions, etc.)- Are there unnecessary allocations, clones, or owned types where borrows wouldsuffice?- Does new code use `.expect()` or `.unwrap()` in functions returning `Result`?@@ -17,6 +15,12 @@- Do the tests follow the project's testing conventions (see tests/CLAUDE.md)?+**CLAUDE.md compliance:**++- Review the CLAUDE.md sections relevant to the changed code and flag+ deviations — code quality, error handling, command execution, data safety,+ system docstrings, etc.+**Documentation accuracy:**When a PR changes behavior, check that related documentation still matches:diff --git a/CLAUDE.md b/CLAUDE.mdindex 7b4dd6c5a..46644c329 100644--- a/CLAUDE.md+++ b/CLAUDE.md@@ -338,6 +338,10 @@ Don't suppress warnings with `#[allow(dead_code)]` — either delete the code orfn validate_config() { ... }```+### System Docstrings++Complex systems (multi-step workflows, state machines, coordination logic) should have a module-level docstring that serves as a spec — purpose, key decisions, behavioral contracts, and invariants. Keep the docstring current as the module evolves.+### No Test Code in Library CodeNever use `#[cfg(test)]` to add test-only convenience methods to library code. Tests should call the real API directly. If tests need helpers, define them in the test module.