go-netops/CLAUDE.md

30 lines
994 B
Markdown
Raw Permalink Normal View History

# CLAUDE.md
UniFi network controller API client for querying devices, clients, networks, routes, and sites.
Module: `forge.lthn.ai/core/go-netops`
## Commands
```bash
go test ./... # run all tests
go test -race ./... # race detector (required before commit)
go test -v -run Name ./... # single test
go vet ./... # vet check
```
## Standards
- UK English
- `go test -race ./...` and `go vet ./...` must pass before commit
- Conventional commits: `type(scope): description`
- Co-Author: `Co-Authored-By: Virgil <virgil@lethean.io>`
- Errors must use `log.E()` from `go-log`, never `fmt.Errorf`
- Config tests must isolate from real `~/.core/config.yaml` via `t.Setenv("HOME", t.TempDir())`
## Docs
- `docs/architecture.md` — package structure, key types, design decisions, API patterns
- `docs/development.md` — prerequisites, build/test, test patterns, coding standards
- `docs/history.md` — extraction origin, known limitations, future plans