Skip to content

AGENTS.md

Latest commit

 

History

History
40 lines (29 loc) · 1.52 KB

AGENTS.md

File metadata and controls

40 lines (29 loc) · 1.52 KB

Project Guidelines

Architecture

Go web application for submitting and reviewing wiki edit patches (subject/episode/person/character). Uses Chi v5 router, Uber Fx for dependency injection, and PostgreSQL via pgx/v5.

Entry point: main.go → Fx app with handler struct holding all dependencies.

Key flows:

  • Users submit patches → stored in PostgreSQL
  • Reviewers accept/reject patches → wiki updated via external API
  • Canal (Debezium CDC) auto-marks patches outdated when wiki changes
  • Notifications sent via Kafka (protobuf-encoded messages on notify.v1 topic)

Code Style

  • Go 1.26, standard library style
  • Templates: templ (.templ files in templates/)
  • SQL: sqlc for type-safe query generation from db/query.sql
  • Error handling: handleError helper returns appropriate HTTP responses
  • HTTP handlers are methods on the handler struct (Chi router)

Build and Test

Uses Taskfile:

  • task build — build binary to dist/app.exe
  • task dev — build and run with dev tag
  • task gen — run sqlc code generation
  • task gen:template — run templ code generation
  • task format — gofmt + templ fmt
  • task migrate — run database migrations

Conventions

  • Session/CSRF middleware via gorilla packages
  • Config loaded from environment variables (see config.go)
  • Database transactions use a tx helper pattern
  • Kafka messages use manual protowire encoding (no generated Go protobuf code)
  • External wiki API calls go through api.go client methods