Skip to content

AGENTS.md

Latest commit

 

History

History
65 lines (46 loc) · 2.35 KB

AGENTS.md

File metadata and controls

65 lines (46 loc) · 2.35 KB
Raw

AGENTS.md

Instructions file for coding agents.

Environment Setup

  • Use the minimum Go version specified in go.mod
  • Warn the user about an old Go version
  • The project uses GNU make for building binaries and images. See Makefile

Commands

Tests

For fast feeback run tests using go test (or gotest if available).

go test -v ./...                               # run all tests with Go directly
go test -v ./pkg/...                           # run Loki package tests
go test -v ./pkg/<pkg>/...                     # run tests in specific package
go test -v -test.run TestName ./pkg/<pkg>/...  # run a specific test

For full verification use dedicated make targets (only when requested).

make test                                      # run full test suite
make test-integration                          # run integration test suite
make test-fuzz                                 # run fuzz tests

Code Style

  • Follow standard Go formatting (gofmt/goimports)
  • Follow import order:
    1. standard lib
    2. external packages
    3. Loki packages (github.com/grafana/loki/v3)
  • Error handling: Always check errors with if err != nil { return ... }
  • Use structured logging with leveled logging (github.com/go-kit/log)
  • Document all exported functions, types, and variables

Testing

  • Always prefer github.com/stretchr/testify/require over github.com/stretchr/testify/assert
  • Use table-driven tests when appropriate

Commits and Pull Requests

  • Always run Loki package tests gotest -v ./pkg/... before commiting
  • Focus on "why", rather than "what" in the commit message and PR description
  • Follow conventional commits format: <type>(<scope>): Your change (note the uppercase after colon)

Documentation Standards

  • Follow the Grafana Writers' Toolkit Style Guide
  • Use CommonMark flavor of markdown for documentation
  • Create LIDs (Loki Improvement Documents) for large functionality changes
  • Document upgrading steps in docs/sources/setup/upgrade/_index.md
  • Preview docs locally with make docs from the /docs directory
  • Include examples and clear descriptions for public APIs

Using Tools

  • When using the mcp__acp__Write tool, write to a path within the current worktree to avoid sandboxing/permissions issues. This includes when writing plan files.