Imported from Y7-Labs/7review (
AGENTS.md). Install upstream withnpx skills add Y7-Labs/7review. Copyright stays with the author.
Repository Guidelines
Project Structure & Module Organization
This repository contains a Go code-review agent for GitHub pull requests and GitLab merge requests. cmd/7review/main.go is the CLI entrypoint. agent/app/ wires HTTP routes and webhook handlers. agent/pipeline/ coordinates the review lifecycle and contains the in-memory run store, memory interfaces, policy filter, and finding validator support. agent/review/ contains normalized request, source, diff, SCM, finding, and report state. agent/tools/ contains concrete GitHub/GitLab API integrations and provider routing. agent/orchestrator/ handles model-role routing and fallbacks, while agent/llm/ contains concrete LLM clients.
If you add new code, keep responsibilities separated by package intent: entrypoint code in cmd/, HTTP composition and webhooks in agent/app, workflow orchestration and deterministic gates in agent/pipeline, review state and domain types in agent/review, SCM integrations in agent/tools, model orchestration in agent/orchestrator, and provider integrations in agent/llm. Place tests beside the code they cover using Go's *_test.go convention.
Build, Test, and Development Commands
gofmt -w ./cmd/7review ./agent/...: format all Go files.go test ./...: run all tests once a validgo.modand package layout are present.go run ./cmd/7review: start the webhook server locally after configuring required environment variables.ORCHESTRATOR_CONFIG=./orchestrator.yaml go run ./cmd/7review: run with the multi-provider role configuration.
The module path is github.com/Y4NN777/7review; keep imports under that path.
Coding Style & Naming Conventions
Use standard Go formatting and idioms. Keep exported names descriptive, such as BuildOrchestrator or review.Context, and keep unexported helpers lower camel case, such as getEnvInt. Prefer small files grouped around a single concept: one provider per file, orchestration logic separate from configuration loading, and HTTP wiring separate from business logic.
Testing Guidelines
Use Go's built-in testing package unless a stronger local convention is introduced. Name tests as TestFunctionName_Behavior, for example TestLoadConfig_MissingGitLabToken. Cover environment parsing, provider fallback behavior, YAML loading, and request validation. Avoid real external API calls in tests; use fake LLMProvider implementations or local HTTP test servers.
Commit & Pull Request Guidelines
No usable git history is available in this working directory, so use concise imperative commit messages, for example Add OpenAI provider fallback. Pull requests should include a short summary, test results, configuration changes, and any screenshots or sample webhook payloads when HTTP behavior changes. Link the relevant issue or merge request when available.
Security & Configuration Tips
Do not commit real tokens or provider API keys. Copy .env.example to a local ignored environment file and set either GitLab or GitHub webhook/API credentials plus the needed model provider keys locally. Keep orchestrator.yaml free of secrets; it should contain model routing only.
Production Runtime Notes
Webhook processing must stay bounded. The HTTP handlers enqueue review work into the server worker pool controlled by WEBHOOK_WORKERS and WEBHOOK_QUEUE_SIZE; do not reintroduce unbounded fire-and-forget goroutines in request handlers. Model batch fan-out is capped by the reasoner role's max_parallel setting in orchestrator.yaml. For multi-instance deployments, add a durable external queue before scaling horizontally so accepted webhook work survives process restarts.
Headroom and MemPalace are required production sidecars. They are external services reached through HEADROOM_URL and MEMPALACE_URL, not Python/TypeScript code embedded in the Go binary. In Docker, use service DNS names such as http://headroom:8787 and http://mempalace:8788; see docs/integrations.md.
