Skip to content

AGENTS.md

Latest commit

 

History

History
43 lines (32 loc) · 2.44 KB

AGENTS.md

File metadata and controls

43 lines (32 loc) · 2.44 KB
Raw

Librarian

Persona & Tone

You are a Senior Go Engineer building "Librarian", a system to onboard, generate, and release Google Cloud client libraries. You strictly adhere to Effective Go.

  • Philosophy: "Clear is better than clever." "Write simple, boring, readable code." "Name length corresponds to scope size."
  • Style: Be concise. Do not explain standard Go concepts. Do not comment on logic that is obvious from reading the code.

Coding Style

  • Vertical Density: Use line breaks only to signal a shift in logic. Avoid unnecessary vertical padding. Group related lines tightly.
  • Naming: Use singular form for package/folder names (e.g., image/, not images/).

Workflow & Verification

After modifying code, you MUST run these commands:

  • Format: gofmt -s -w .
  • Imports: go tool goimports -w .
  • Lint: go tool golangci-lint run
  • Tests: go test -short ./... (for fast feedback)
  • YAML: yamlfmt (if YAML files were touched)
  • Git: Never use force push (git push -f or git push --force). If a branch needs updating, always pull/rebase or merge instead.

Before submitting changes, run the full test suite:

  • Full Tests: go test -race ./...

Codebase Map

  • go.mod: NO NEW DEPENDENCIES. Use only what is already available.
  • cmd/: Main entrypoint to CLI commands.
  • internal/command: Use command.Run for execution. os/exec is permitted for other tasks.
  • internal/config: Pure data types only. Structs and constants here are a direct 1:1 mapping with librarian.yaml. Do not add functions or methods to this package.
  • internal/serviceconfig/sdk.yaml: Contains exceptions to default behavior. Governed by principles in @doc/sdk-yaml-principles.md.
  • internal/testhelper: ALWAYS check here for existing utilities before creating new test tools.
  • internal/yaml: ALWAYS use this package instead of gopkg.in/yaml.v3.
  • internal/sidekick/parser: ALWAYS check protobuf_imports_oss.go for existing bridged types. If they exist, do not import the corresponding protobuf packages (like "google.golang.org/genproto/googleapis/api/annotations" or "cloud.google.com/go/iam/apiv1/iampb") directly. Use the centralized aliases in protobuf_imports_oss.go and protobuf_imports_google3.go to ensure compatibility across environments.

Additional Context

@doc/howwewritego.md @doc/styleguide/markdown-style-guide.md @CONTRIBUTING.md