From 5402e46c7d3d1239b49624ab2bd116d1b195bfdc Mon Sep 17 00:00:00 2001 From: wonder Date: Tue, 5 May 2026 11:07:34 +0800 Subject: [PATCH] docs: add CLAUDE.md with project conventions and auto-commit guidelines --- CLAUDE.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..1cac0ac --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,61 @@ +# CLAUDE.md + +This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. + +## Project Overview + +This is an **Eino framework** project (Go-based AI application framework by ByteDance/CloudWeGo). The repository is in its early stages. + +## Build & Development Commands + +```bash +# Initialize Go module (if not done) +go mod init eino-test + +# Build +go build ./... + +# Run +go run . + +# Test all +go test ./... + +# Test a single package +go test ./path/to/package/ + +# Test a single function +go test ./path/to/package/ -run TestFunctionName + +# Lint (install golangci-lint if needed) +golangci-lint run ./... + +# Tidy dependencies +go mod tidy +``` + +## Auto-Commit Convention + +After completing each discrete subtask (file creation, feature implementation, bug fix, refactor), automatically generate a conventional commit message and commit. **Do NOT push.** + +Process: +1. Stage the relevant changed files (`git add `) +2. Generate a commit message following Conventional Commits format: + - `feat: ` for new features + - `fix: ` for bug fixes + - `refactor: ` for code refactoring + - `docs: ` for documentation + - `test: ` for test additions/changes + - `chore: ` for tooling/config changes +3. Commit with `git commit -m ""` +4. Never run `git push` unless explicitly asked + +Use a SubAgent for commit generation when the change is non-trivial, to keep the main context clean. + +## Architecture + +(To be updated as the project grows.) + +## Key Dependencies + +(To be updated as dependencies are added.)