Skip to content

Commit bc9ea62

Browse files
NikolaySClaude
and
Claude
committed
docs: add CLAUDE.md file with repo guidance for agentic tools
Add guidance file for Claude Code (claude.ai/code) containing build commands, test instructions, and code style guidelines to help AI assistants work effectively with this repository. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 079fc80 commit bc9ea62

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

Diff for: CLAUDE.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## Build/Test/Lint Commands
6+
- Build all components: `cd engine && make build`
7+
- Lint code: `cd engine && make lint`
8+
- Run unit tests: `cd engine && make test`
9+
- Run integration tests: `cd engine && make test-ci-integration`
10+
- Run a specific test: `cd engine && GO111MODULE=on go test -v ./path/to/package -run TestName`
11+
- Run UI: `cd ui && pnpm start:ce` (Community Edition) or `pnpm start:platform`
12+
13+
## Code Style Guidelines
14+
- Go code follows "Effective Go" and "Go Code Review Comments" guidelines
15+
- Use present tense and imperative mood in commit messages
16+
- Limit first commit line to 72 characters
17+
- All Git commits must be signed
18+
- Format Go code with `cd engine && make fmt`
19+
- Use error handling with pkg/errors
20+
- Follow standard Go import ordering
21+
- Group similar functions together
22+
- Error messages should be descriptive and actionable
23+
- UI uses pnpm for package management

0 commit comments

Comments
 (0)