docs: add agent guides (AGENTS.md, CLAUDE.md, path-scoped rules)#379
Merged
Conversation
Rename the macOS-FFI directory guide from CLAUDE.md to AGENTS.md so agents that follow the nested-AGENTS.md convention pick it up, and keep a thin CLAUDE.md that imports it for Claude Code.
AGENTS.md is the tool-agnostic contract: architecture map, the devenv/direnv build gate, Rust type-system standards, git/GitHub and release conventions, and an index of subsystem rules. CLAUDE.md imports it and adds Claude Code specifics. The .claude/rules/ files carry the deep per-subsystem constraints (GUI theming and pins, i18n key parity, append-only IPC wire format, HID++ vocabularies, hook freeze hazard) and are now tracked via a narrowed .gitignore carve-out.
Greptile SummaryThis PR adds committed guidance for coding agents across the repo.
Confidence Score: 4/5This is close, but the nested platform guide import should be fixed before merging.
crates/openlogi-gui/src/platform/CLAUDE.md Important Files Changed
Reviews (2): Last reviewed commit: "docs: add xtask/packaging rule to the ag..." | Re-trigger Greptile |
Point at xtask/README.md as the crate contract and add what it doesn't cover: workspace lints apply to xtask too, the committed-PNG icon pipeline (no CDN fetch, Dock icon cache), declarative nfpm/WiX package manifests, and why cargo-run-macos.sh and the release-notes tool stay outside xtask.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Give coding agents (Claude Code, Codex, and anything else that reads AGENTS.md) a first-class, committed picture of this repo: what it is, how it is built and verified, the Rust standards it holds itself to, and the git/GitHub/release conventions that were previously carried only by example.
Changes
direnv exec), type-system-first Rust standards distilled from the workspace lints and past audits, commit/branch/PR/merge conventions extracted from 172 merged PRs and 300 master commits, release-plz rules, and an index of subsystem rule files.@AGENTS.mdimport plus Claude-specific notes (auto-loaded rules, local gpui skills).gui.md(theme duality, gpui lock pins, capability-gated panels),i18n.md(ordered key parity across 20 locales),ipc-protocol.md(append-only tarpc/bincode wire format + golden tests),hidpp.md(vendored fork, four device-kind vocabularies),hook.md(CGEventTap freeze hazard).AGENTS.md(nested-AGENTS.md convention) with a thinCLAUDE.mdimporting it; content unchanged./.claude/to/.claude/*with a!/.claude/rules/carve-out so the rules are tracked while worktrees/local settings stay ignored.Testing
prekbuiltin hooks (whitespace/EOF/large-file checks) passed on both commits; no Rust code touched, so fmt/clippy were correctly skipped.git statusshows only.claude/rules/as trackable after the gitignore change (worktrees and settings.json remain ignored).