Skip to content

docs: add explicit naming guidance to AGENTS #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benvinegar merged 1 commit into from
Feb 22, 2026
Merged

docs: add explicit naming guidance to AGENTS #134

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@ sudo baudbot rollback previous
**Strong defaults:**
- When behavior changes, update docs in the same PR (`README.md`, `docs/*`, `CONFIGURATION.md`, and relevant `AGENTS.md` files).
- Prefer distro-agnostic shell; distro-specific branches are acceptable when reliability improves.
- Prefer explicit, domain-aware naming for shared code (`FooRequestBody`, `SlackWorkspaceKVRecord`, `BrokerHttpResponse`, etc.).
- Keep action names semantic (`activateWorkspace`), and use storage/runtime qualifiers on read/write helpers when helpful (`getWorkspaceKVRecord`, `putWorkspaceDBRow`).
- 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.

## Tests and quality gates

Expand Down