gollem: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Restriction & Rules

• In principle, do not trust developers who use this library from outside
  • Do not export unnecessary methods, structs, and variables
  • Assume that exposed items will be changed. Never expose fields that would be problematic if changed
  • Use export_test.go for items that need to be exposed for testing purposes
• When making changes, before finishing the task, always:
  • Run go vet ./..., go fmt ./... to format the code
  • Run golangci-lint run ./... to check lint error
  • Run gosec -quiet ./... to check security issue
  • Run tests to ensure no impact on other code
• All comment and character literal in source code must be in English
• Test files should have package {name}_test. Do not use same package name
• Test must be included in same name test file. (e.g. test for abc.go must be in abc_test.go)
• Use named empty structure (e.g. type ctxHogeKey struct{} ) as private context key
• Do not create binary. If you need to run, use go run command instead
• When a tmp directory is specified, search for files within the ./tmp directory relative to the project root.
• Naming Convention: In Go, package names already express the subject, so avoid redundancy in method/struct names
  • Good: openai.New(), claude.WithModel(), gemini.ThinkingLevel
  • Bad: openai.NewOpenAIClient(), claude.WithClaudeModel(), gemini.GeminiThinkingLevel
• Environment Variables: Outside of test code, NEVER use os.Getenv() or os.LookupEnv() directly. Always use github.com/urfave/cli/v3 for environment variable access
  • This ensures proper configuration management and testability
  • Test code may use os.Getenv() for test setup purposes

Commands

Development and Testing

• task or task mock - Generate mock files for testing (uses moq)
• go test ./... - Run all tests (MUST run before exiting tasks)
• go test -v ./llm/openai/ - Run tests for specific package
• go test -v ./path/to/package - Run specific package tests when developing
• go build ./... - Build all packages
• go mod tidy - Clean up dependencies