Skip to content

Commit 80051ac

Browse files
committed
chore: trim AGENTS.md to remove generic guidance
Remove sections that restate default Claude/Go behavior (communication style, debugging philosophy, documentation conventions, camelCase). Remove stale maxStateSizeBytes constant reference. Delete stale worktree CLAUDE.md.
1 parent 8bcb0d8 commit 80051ac

1 file changed

Lines changed: 14 additions & 20 deletions

File tree

AGENTS.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,19 @@
1-
# Repository Guidelines
1+
# Repository guidelines
22

3-
## communication style
4-
Answer every direct question first, then describe next steps or alternatives. Stay focused on the user’s immediate request; do not propose architecture shifts unless asked. Ask for clarification only when essential, and prefer execution or code reading over speculation.
3+
## Version control and workflow
4+
This repository uses Jujutsu (`jj`), not git. Use commands such as `jj status`, `jj commit`, and `jj new` when manipulating history.
55

6-
## version control and workflow
7-
This repository uses Jujutsu (`jj`), not git. Use commands such as `jj status`, `jj commit`, and `jj new` when manipulating history. Keep work in logical, reviewable stacks and avoid rewriting commits that belong to others without coordination.
6+
## Build and test commands
7+
Primary language is Go. Validate changes with `make build` and `make test` (which wrap `go build ./...` and `go test ./...`). Regenerate protobufs via `make generate` (Buf) whenever files in `proto/` change. Use `go test -race ./pkg/broker` for concurrency-sensitive paths.
88

9-
## build and test commands
10-
Primary language is Go. Always validate changes with `make build` and `make test` (which wrap `go build ./...` and `go test ./...`). Regenerate protobufs via `make generate` (Buf) whenever files in `proto/` change. Clean build artifacts using `make clean` or `make clean-all` before release builds to ensure reproducibility.
9+
## Coding standards
10+
Keep module folders aligned with runtime components (`cmd/epithet`, `pkg/broker`, `pkg/policyserver`). Never edit generated files in `pkg/brokerv1`. Before proposing custom code that wraps or extends a library, check the library's README, docs, and ecosystem for existing companion packages that already solve the problem.
1111

12-
## coding and engineering standards
13-
Prefer straightforward, composable Go code. Encode invariants in types whenever possible and treat error handling comprehensively—model every failure mode and provide actionable error messages. Default to camelCase identifiers, keep module folders aligned with runtime components (`cmd/epithet`, `pkg/broker`, `pkg/policyserver`), and never edit generated files in `pkg/brokerv1`. Before proposing custom code that wraps or extends a library, check the library's README, docs, and ecosystem for existing companion packages that already solve the problem.
12+
## Task tracking and commits
13+
Track work in `yatl`; do not introduce other TODO systems. Follow Conventional Commits (`feat:`, `fix:`, `chore:`, `docs:`) written in the imperative so tooling like `svu next` can infer versions.
1414

15-
## debugging and validation
16-
Investigate the exact symptom described; confirm behavior by reading source or running the code rather than relying on conventions. Add regression tests when fixing bugs and include stress or race tests for concurrency-sensitive paths (`go test -race ./pkg/broker`). When in doubt, reproduce issues with minimal commands instead of wide-ranging exploration.
17-
18-
## documentation and comments
19-
All headings and titles must use sentence case. Comments should explain “why” rather than “what,” end with periods, and accompany exported APIs. Architecture, authentication, and policy docs live under `docs/`; keep them synchronized with code-level changes.
20-
21-
## task tracking and commits
22-
Track work in `yatl`; do not introduce other TODO systems. Follow Conventional Commits (`feat:`, `fix:`, `chore:`, `docs:`) written in the imperative so tooling like `svu next` can infer versions. Pull requests must summarize intent, include validation steps (`make test`, specific `go test` packages), and attach relevant screenshots or logs.
23-
24-
## important constants
25-
Key limits include `caserver.RequestBodySizeLimit = 8192`, `pkg/broker/auth.go:maxStateSizeBytes = 10 MiB`, `pkg/broker/broker.go:maxRetries = 3`, `pkg/broker/broker.go:expiryBuffer = 5 seconds`, and `pkg/broker/broker.go:cleanupInterval = 30 seconds`. Keep these constraints in mind when modifying request handling, state storage, or cleanup loops.
15+
## Important constants
16+
- `caserver.RequestBodySizeLimit = 8192`: maximum HTTP request body size for CA requests.
17+
- `pkg/broker/broker.go:maxRetries = 3`: maximum retry attempts for CA 401 errors and auth failures.
18+
- `pkg/broker/certs.go:expiryBuffer = 5 seconds`: safety margin for certificate expiry checks.
19+
- `pkg/broker/broker.go:cleanupInterval = 30 seconds`: frequency of expired agent cleanup.

0 commit comments

Comments
 (0)