|
|
@@ -104,6 +104,17 @@ prints JSON before returning non-zero.
|
|
|
- Output should be machine-parseable (JSON when possible)
|
|
|
- Cross-platform from day one
|
|
|
|
|
|
+## Consistency
|
|
|
+
|
|
|
+Names used in code must appear identically everywhere. Before any edit:
|
|
|
+
|
|
|
+1. **Binary name** — the `go build -o` target (usually `$GOBIN/$module_name`) must match every example in README, AGENTS.md, comments, and docs.
|
|
|
+2. **CLI command** — the root command name (e.g. `qmk-rgb`) is the binary name; every usage example, CLI reference table, and doc must use the same string.
|
|
|
+3. **Module path** — the `go.mod` module path is the source of truth for `go install` targets.
|
|
|
+4. **Zone names** — `logo`, `backlight`, `side` must be identical in code, docs, and examples.
|
|
|
+
|
|
|
+When you see a name in one file, grep for it across the whole repo before deciding if a change is consistent.
|
|
|
+
|
|
|
## Code vs Documentation
|
|
|
|
|
|
All documentation (README.md, comments, AGENTS.md) must stay in sync with the code.
|