Agent Guidelines

This document contains guidelines for AI agents working on this codebase.

Code Comments

All code comments must be written in English.

Inline comments, function documentation, and package documentation should use English
Variable names and function names should follow Go naming conventions
Error messages and log messages should be in English
This ensures consistency and maintainability across the codebase

The linter is run with golangci-lint run from the project root.

If golangci-lint is not installed, it can be installed using:

curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/HEAD/install.sh | sh -s -- -b $(go env GOPATH)/bin v2.4.0

(The version v2.4.0 is specified in .github/workflows/lint.yml. This installation command is taken from the official documentation)

Every pull request must include a changelog entry in CHANGELOG.md.

Rules for adding a changelog entry:

Only include user-facing changes: API changes (additions, renames, deletions, deprecations) or behavior changes. Internal refactoring or non-observable changes do not require an entry.
Use past tense verbs (e.g., "Added", "Fixed", "Changed", "Removed", "Deprecated").
Insert the new line(s) at the very beginning of CHANGELOG.md, before any existing entries.
Do not include a version number — version numbers are assigned by the maintainer at release time (see .github/workflows/publish.yml).

Example entry format:

* Added `query.WithLazyTx(bool)` option for `query.Client.DoTx` calls to enable/disable lazy transactions per operation

If the pull request contains no user-facing changes, add the label no changelog to the PR to skip the changelog check.

Do not update go.mod or go.sum unless the task explicitly requires it.

Do not add, remove, or upgrade dependencies as a side effect of making code changes.
If a dependency change is truly necessary to complete the task, document it clearly in the PR description.
Never run go mod tidy or go get unless the task requires a dependency change.