diff --git a/AGENTS.md b/AGENTS.md index 5052896..23d6bcd 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -11,7 +11,7 @@ Raspberry Pi systems. Read the relevant code and these guides before changing it - Create and switch to a feature branch before editing files or making commits. - Never commit directly on `main` or `master`. -- Use descriptive branch names, such as `feat/mpd-fifo-output-monitoring`, +- Use descriptive branch names, such as `feature/mpd-fifo-output-monitoring`, `fix/readme-images`, or `chore/agent-instructions`. - Continue on an existing feature branch when working on the same task. Create a separate branch from the target branch for unrelated work. @@ -74,7 +74,7 @@ GOOS=linux GOARCH=arm64 go test -exec /usr/bin/true ./player/... git diff --check ``` -Run `gofmt` on changed Go files. The Makefile has no test, lint, integration-test, +Run `goimports` on changed Go files. The Makefile has no test, lint, integration-test, or generation targets. Linux wireless helpers prevent some packages from building natively on macOS. Report cross-compilation separately from executed tests and hardware verification. Use race tests on Linux when changing shared state. diff --git a/docs/agents/CodingConventions.md b/docs/agents/CodingConventions.md index 51beda9..e4844ad 100644 --- a/docs/agents/CodingConventions.md +++ b/docs/agents/CodingConventions.md @@ -1,6 +1,6 @@ # Coding conventions -- Use idiomatic Go, `gofmt`, and the surrounding package's naming and import style. +- Use idiomatic Go, `goimports`, and the surrounding package's naming and import style. Extend existing contracts instead of introducing parallel registries or layers. - Wrap propagated errors with useful context and `%w`. Use `errors.Is` or `errors.As` when callers need to recognize them. @@ -17,6 +17,3 @@ - Put focused tests beside implementations. Cover parsing, malformed input, detection precedence, failures and recovery with temporary files or fake servers. Unit tests should run without physical GPIO, displays or a live MPD instance. - -Adapted from [Flow's coding guide](https://github.com/onflow/flow-go/blob/master/docs/agents/CodingConventions.md), -with BeatGlow-specific lifecycle, logging and hardware guidance. diff --git a/docs/agents/GoDocs.md b/docs/agents/GoDocs.md index fbb4d4c..ea2bb52 100644 --- a/docs/agents/GoDocs.md +++ b/docs/agents/GoDocs.md @@ -17,5 +17,3 @@ documentation after checking the implementation; keep separate logic fixes scoped. - Wrap prose around 100 characters where practical. Avoid documenting obvious implementation steps or adding repetitive boilerplate. - -Adapted from [Flow's Go documentation guide](https://github.com/onflow/flow-go/blob/master/docs/agents/GoDocs.md). diff --git a/docs/agents/OperationalDoctrine.md b/docs/agents/OperationalDoctrine.md index e483784..73483ed 100644 --- a/docs/agents/OperationalDoctrine.md +++ b/docs/agents/OperationalDoctrine.md @@ -16,5 +16,3 @@ critical without evidence or claim a fix is verified on hardware without testing it. - Finish with concise results, links to changed files or the PR, and material limitations. Never report a PR created when only its branch was pushed. - -Adapted from [Flow's operational guide](https://github.com/onflow/flow-go/blob/master/docs/agents/OperationalDoctrine.md).