Conversation
| └── iota-sdk-ffi/ # FFI for language bindings (not published) | ||
|
|
||
| bindings/ | ||
| ├── go/ # Go bindings with examples |
There was a problem hiding this comment.
probably shouldn't mention that only for Go
| ├── go/ # Go bindings with examples | |
| ├── go/ # Go bindings |
| ```rust | ||
| use iota_sdk::graphql_client::Client; | ||
|
|
||
| let client = Client::devnet(); |
There was a problem hiding this comment.
Claude, why come up with wrong method names?
| let client = Client::devnet(); | |
| let client = Client::new_devnet(); |
| make clippy | ||
|
|
||
| # Format code (requires nightly) | ||
| make fmt |
There was a problem hiding this comment.
Should maybe also have the fmt for bindings and examples here?
| ## Crate Responsibilities | ||
|
|
||
| | Crate | Purpose | | ||
| | ------------------------------ | --------------------------------------------------------------------------- | | ||
| | `iota-sdk` | Umbrella crate that re-exports all functionality via feature flags | | ||
| | `iota-sdk-types` | Core types: Address, ObjectId, Transaction, Checkpoint, etc. BCS-compatible | | ||
| | `iota-sdk-crypto` | Signing traits (`IotaSigner`, `IotaVerifier`) and implementations | | ||
| | `iota-sdk-graphql-client` | Type-safe GraphQL client using `cynic` for schema-derived types | | ||
| | `iota-sdk-transaction-builder` | Fluent API for building transactions (online/offline modes) | |
There was a problem hiding this comment.
Almost the same as Repository Structure, should probably merge them
There was a problem hiding this comment.
Pull request overview
This PR introduces documentation files to help AI agents understand and work with the IOTA Rust SDK repository structure, conventions, and workflows.
Changes:
- Adds comprehensive AI agent documentation covering project structure, build commands, code conventions, and common development tasks
- Creates a reference file pointing to the main agent documentation
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| AGENTS.md | Comprehensive guide for AI agents with repository structure, code conventions, testing patterns, and common development workflows |
| CLAUDE.md | Reference file containing only "AGENTS.md" text |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1 @@ | |||
| AGENTS.md No newline at end of file | |||
There was a problem hiding this comment.
The CLAUDE.md file contains only the text 'AGENTS.md' without any context or explanation. Consider adding a brief description of its purpose, such as a redirect notice or explanation that this file references AGENTS.md for Claude-specific agent guidance.
| AGENTS.md | |
| # Claude agent guidance | |
| This file serves as a redirect for Claude-specific agent instructions. | |
| For detailed guidance on how Claude should behave in this repository, | |
| please see [AGENTS.md](AGENTS.md). |
There was a problem hiding this comment.
When actually it doesn't seems to be a symlink, not sure what happened, I'll fix
|
@thibault-martinez I've opened a new pull request, #544, to work on those changes. Once the pull request is ready, I'll request review from you. |
No description provided.