Skip to content

docs: add CLAUDE.md project guide#14

Merged
juntao merged 2 commits intomainfrom
feat/claude-md
Mar 15, 2026
Merged

docs: add CLAUDE.md project guide#14
juntao merged 2 commits intomainfrom
feat/claude-md

Conversation

@juntao
Copy link
Member

@juntao juntao commented Mar 15, 2026

Summary

  • Add CLAUDE.md with comprehensive project guide for AI agents and developers

What's covered

  • Project overview — purpose, supported exchanges, asset classes
  • Repository structure — every directory and key file explained with annotations
  • Building — debug and release build commands
  • Testing — lint commands (exact CI commands: cargo fmt -- --check, cargo clippy --release -- -D warnings), unit tests, E2E tests, example scripts
  • Examples conventions — must have README.md, must use Python (stdlib only), must call CLI binaries not raw APIs, follow existing patterns
  • PR and documentation requirements — every new feature/breaking change must update README.md, skills/SKILL.md, skills/bootstrap.sh, skills/install.md
  • Submission rules — no direct push to main, DCO signing, CI must pass
  • Architecture notes — one binary per exchange, JSON I/O, config file, HIP-3 collateral tokens

Test plan

  • CI lint passes (no Rust changes, markdown only)
  • Verified content accuracy against actual project structure

🤖 Generated with Claude Code

juntao and others added 2 commits March 15, 2026 03:02
Covers project purpose and structure, building and testing (including
lint requirements), examples directory conventions, and PR/documentation
requirements for new features and breaking changes.

Signed-off-by: Michael Yuan <michael@secondstate.io>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Michael Yuan <michael@secondstate.io>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@juntao juntao merged commit dcd7cf6 into main Mar 15, 2026
2 checks passed
@juntao juntao deleted the feat/claude-md branch March 15, 2026 10:08
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