Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (53 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

79 lines (53 loc) · 2.85 KB

Contributing

Thank you for helping improve Agentic Control Plane. This document describes how to work on the repo locally and what we expect in pull requests.

All participants are expected to follow the Code of Conduct.

Prerequisites

  • Go 1.22+ (see go.mod)
  • GNU Make (optional; the Makefile wraps common Go commands)

Getting started

git clone https://github.com/LAA-Software-Engineering/agentic-control-plane.git
cd agentic-control-plane
go mod download
make build    # or: go build -o bin/agentctl ./cmd/agentctl

Run make or make help for a full list of targets.

Before you open a pull request

  1. Format — make fmt or ensure gofmt -l . prints nothing (same check as CI).
  2. Static analysis — make vet (or go vet ./...).
  3. Tests — make test (go test ./... -race).

A convenient local gate (format check, vet, tests; no build):

make ci

CI in .github/workflows/ci.yml also builds agentctl, runs tests with -count=1 -shuffle=on -timeout=10m, and writes a coverage profile. To mirror that test invocation closely:

go test -race -count=1 -shuffle=on -timeout=10m ./...
go build -o bin/agentctl ./cmd/agentctl

CLI golden tests

If you intentionally change table (or other) CLI output captured by golden files:

GO_UPDATE_GOLDEN=1 go test ./internal/cli/... -run TestGolden_

Commit the updated files under internal/cli/testdata/ with your change.

Project layout

High-level map (details in README.md and docs/DESIGN_DOC.md):

Area Path
CLI entrypoint cmd/agentctl
Commands, flags, golden tests internal/cli
YAML spec types and validation internal/spec, internal/project
Plan / apply / engine / policy internal/plan, internal/apply, internal/engine, internal/policy
SQLite state internal/state/sqlite
End-to-end CLI tests test/integration

Code style

  • Match existing patterns in nearby files (naming, error handling, test style).
  • Prefer small, focused changes; avoid unrelated refactors in the same PR.
  • Keep user-visible strings and behaviour aligned with docs/DESIGN_DOC.md when touching the CLI or YAML semantics.

Pull requests

  • Describe what changed and why (context for reviewers).
  • Link related issues when applicable.
  • Ensure CI would pass (formatting, vet, tests, build). Note: pushes that only change Makefile or **/*.md do not trigger CI via paths-ignore; for doc-only edits, run make ci locally if you also changed Go code elsewhere in the same branch.

License

By contributing, you agree that your contributions will be licensed under the same terms as the project: MIT.