Skip to content

docs: add AGENTS.md#15

Closed
realmeylisdev wants to merge 1 commit into
cashubtc:masterfrom
realmeylisdev:add-agents-md
Closed

docs: add AGENTS.md#15
realmeylisdev wants to merge 1 commit into
cashubtc:masterfrom
realmeylisdev:add-agents-md

Conversation

@realmeylisdev
Copy link
Copy Markdown
Contributor

What

Adds an AGENTS.md to cdk-flutter — agent-oriented contribution guidance following the pattern already in nutshell, cashu-ts, and cdk, and being proposed for nuts.

Why

  • Ecosystem alignment — the other Cashu repos already have one.
  • cdk-flutter has a non-obvious build pipeline: hand-written Rust under rust/src/api/ generates Dart bindings in lib/src/rust/. Without explicit guidance an agent is likely to hand-edit the generated tree, which gets overwritten on the next just generate.
  • Codifies the autonomous-vs-human-review boundary (e.g. rust/src/api/ signature changes and cdk version bumps should flag for a human; doc/formatting/test work is safe for an agent to ship directly).

Structure

  • Overview / common commands — lifts the command table directly from justfile so the two stay in sync.
  • Environment setup — pins flutter_rust_bridge_codegen 2.11.1 (must match the runtime pin in pubspec.yaml / rust/Cargo.toml); this is a real gotcha I hit locally (cargo install flutter_rust_bridge_codegen without --version grabs 2.12.0, which then fails codegen).
  • Code Generation Boundaries — the Flutter-Rust-bridge specific section: enumerates exactly which paths are hand-written and which are generated.
  • Autonomous vs. Human-Required Changes — modeled on cashubtc/nutshell/AGENTS.md.
  • Architecture Overview — file tree with purpose annotations.

Scope

Happy to adjust tone, structure, or sections to match what you'd prefer — the nutshell format was my best guess at the house style.

Adds agent-oriented contribution guidance to cdk-flutter, following the
ecosystem pattern set by nutshell, cashu-ts, and cdk. Includes a
flutter_rust_bridge-specific "Code Generation Boundaries" section that
names which files are hand-written vs. generated (rust/src/api/ vs.
lib/src/rust/) so agents don't hand-edit generated Dart bindings.

Also documents the autonomous-vs-human-review boundary, lifting the
nutshell convention: safe for agents (docs, tests, formatting); needs
human review (rust/src/api/ signature changes, cdk version bumps,
crypto/signing code, platform-native glue, DB migrations, NUT protocol
behavior).
@realmeylisdev
Copy link
Copy Markdown
Contributor Author

Closing for the same reason as #16 — AGENTS.md for a repo that's being replaced by cdk-dart isn't worth the review cycle. If a future Flutter wrapper on top of cdk-dart ends up wanting agent-oriented docs, happy to port this there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant