docs: add AGENTS.md#15
Closed
realmeylisdev wants to merge 1 commit into
Closed
Conversation
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).
This was referenced Apr 24, 2026
Contributor
Author
|
Closing for the same reason as #16 — AGENTS.md for a repo that's being replaced by |
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.
What
Adds an
AGENTS.mdtocdk-flutter— agent-oriented contribution guidance following the pattern already innutshell,cashu-ts, andcdk, and being proposed fornuts.Why
cdk-flutterhas a non-obvious build pipeline: hand-written Rust underrust/src/api/generates Dart bindings inlib/src/rust/. Without explicit guidance an agent is likely to hand-edit the generated tree, which gets overwritten on the nextjust generate.rust/src/api/signature changes andcdkversion bumps should flag for a human; doc/formatting/test work is safe for an agent to ship directly).Structure
justfileso the two stay in sync.flutter_rust_bridge_codegen 2.11.1(must match the runtime pin inpubspec.yaml/rust/Cargo.toml); this is a real gotcha I hit locally (cargo install flutter_rust_bridge_codegenwithout--versiongrabs 2.12.0, which then fails codegen).cashubtc/nutshell/AGENTS.md.Scope
CHANGELOG.mdbump.Happy to adjust tone, structure, or sections to match what you'd prefer — the nutshell format was my best guess at the house style.