From 8ebb5f15d515ea74324c36ac0df854edddc32d2f Mon Sep 17 00:00:00 2001 From: Dan Revie Date: Thu, 30 Apr 2026 18:23:53 -0400 Subject: [PATCH 1/2] Add shared agent instructions --- AGENT.md | 1 + AGENTS.md | 39 +++++++++++++++++++++++++++++++++++++++ CLAUDE.md | 1 + 3 files changed, 41 insertions(+) create mode 120000 AGENT.md create mode 100644 AGENTS.md create mode 120000 CLAUDE.md diff --git a/AGENT.md b/AGENT.md new file mode 120000 index 0000000..47dc3e3 --- /dev/null +++ b/AGENT.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..e135568 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,39 @@ +# Agent Instructions + +`AGENTS.md` is the canonical repo guidance for agents. Keep these instructions +here and keep agent-specific entrypoints as symlinks to this file; do not edit +the symlinks separately. `CLAUDE.md` points here for Claude Code. `AGENT.md` +is a compatibility alias for singular agent-file readers; current Amp reads +`AGENTS.md` directly and also recognizes `AGENT.md` only as a fallback. + +## Repo Shape + +- Version Guard is a Go service for infrastructure version drift detection. +- Temporal workflows and activities are under `pkg/workflow`; keep workflow + code deterministic and put network, clock, and storage effects in activities. +- The Helm chart lives in `charts/version-guard`; keep chart values, templates, + and chart metadata in sync when deployment behavior changes. +- Resource definitions are config-driven in `pkg/config/defaults/resources.yaml`. + Prefer the transforms DSL in `TRANSFORMS.md` before adding custom code for + inventory reshaping. + +## Development Workflow + +- Use the existing Makefile targets instead of one-off command variants: + `make build-all`, `make test`, `make test-ci`, `make lint`, `make fmt-all`, + and `make check`. +- For chart changes, mirror the GitHub Actions workflow with + `ct lint --target-branch main --charts charts/version-guard` when chart-testing + is available. +- Keep Go tests next to the package they cover. Prefer table-driven tests for + policy, parser, config, and transform behavior. +- Run focused package tests while iterating, then the relevant Makefile target + before handing off. + +## Metrics And Docs + +- Do not claim custom application or business metrics unless the code implements + them. The supported metrics surface is the Temporal Go SDK Prometheus/OpenMetrics + endpoint exposed by the worker. +- Keep documentation aligned with the Makefile, docker-compose setup, Temporal + workflow behavior, and Helm chart defaults. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 120000 index 0000000..47dc3e3 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file From 99cd5952cb347e2b33e3970ab5a5dce81b6f2959 Mon Sep 17 00:00:00 2001 From: Dan Revie Date: Thu, 30 Apr 2026 18:55:13 -0400 Subject: [PATCH 2/2] Reference contributing guide in agent instructions --- AGENTS.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index e135568..c6eafc1 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -19,6 +19,8 @@ is a compatibility alias for singular agent-file readers; current Amp reads ## Development Workflow +- Read `CONTRIBUTING.md` before making changes that affect contribution flow, + release flow, CI expectations, or repository conventions. - Use the existing Makefile targets instead of one-off command variants: `make build-all`, `make test`, `make test-ci`, `make lint`, `make fmt-all`, and `make check`.