Skip to content

Commit 85d955a

Browse files
authored
docs: add explicit naming guidance to AGENTS (#134)
1 parent c5fb6bc commit 85d955a

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,9 @@ sudo baudbot rollback previous
7070
**Strong defaults:**
7171
- When behavior changes, update docs in the same PR (`README.md`, `docs/*`, `CONFIGURATION.md`, and relevant `AGENTS.md` files).
7272
- Prefer distro-agnostic shell; distro-specific branches are acceptable when reliability improves.
73+
- Prefer explicit, domain-aware naming for shared code (`FooRequestBody`, `SlackWorkspaceKVRecord`, `BrokerHttpResponse`, etc.).
74+
- Keep action names semantic (`activateWorkspace`), and use storage/runtime qualifiers on read/write helpers when helpful (`getWorkspaceKVRecord`, `putWorkspaceDBRow`).
75+
- Local variables may be lighter-weight when scope is short and context is obvious, but avoid ambiguous names (`data`, `payload`, `body`, `response`) when crossing boundaries.
7376

7477
## Tests and quality gates
7578

0 commit comments

Comments
 (0)