Skip to content

Commit fe872b2

Browse files
committed
docs: clarify agent-facing product contract
1 parent 03e541a commit fe872b2

1 file changed

Lines changed: 20 additions & 4 deletions

File tree

AGENTS.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,20 @@
11
# Repository working agreements
22

3+
## What we are building
4+
5+
GitContribute is a local-first research and validation workbench for coding
6+
agents. It gives agents durable repository and GitHub facts, bounded acquisition
7+
and workspace capabilities, and source-bound validation evidence. Agents do the
8+
reasoning and contribution work; GitContribute provides the trustworthy local
9+
context and explicit capabilities they need. It does not hide network access,
10+
process execution, local writes, or GitHub mutation inside reads.
11+
12+
Treat missing, stale, incomplete, or superseded coverage as unknown rather than
13+
as negative evidence. Keep imported external claims distinct from validation
14+
reproduced by GitContribute. For the detailed contracts, read
15+
`docs/architecture.md`, `CONTRIBUTING.md`, and, for MCP or evidence changes,
16+
`docs/mcp-composed-workflows.md` and `docs/external-evidence-manifests.md`.
17+
318
## Product boundaries
419

520
- Follow the contracts in `docs/architecture.md`; do not preserve Gitcrawl
@@ -20,14 +35,15 @@
2035
- No GitHub mutation is in scope unless explicitly approved.
2136
- Never execute repository-controlled code during crawling or indexing.
2237

23-
## Go changes
38+
## Engineering rules
2439

2540
- Keep packages focused and interfaces narrow; avoid config bags and mode
2641
booleans.
2742
- Pass `context.Context` through I/O and long-running operations.
28-
- Make crawl writes idempotent and prevent stale observations from replacing
29-
newer projections.
43+
- Make acquisition, sync, indexing, and projection writes idempotent; prevent
44+
stale observations from replacing newer projections.
3045
- Replace child snapshots atomically only after complete retrieval.
31-
- Run `gofmt` on changed Go files and `go test ./...` before committing.
46+
- Run `gofmt` on changed Go files and focused tests while working; run
47+
`make verify` before opening a pull request.
3248
- Add focused regression tests for ordering, resumability, cancellation, and
3349
side-effect boundaries.

0 commit comments

Comments
 (0)