Skip to content

docs: add explicit naming guidance to AGENTS#134

Merged
benvinegar merged 1 commit into
mainfrom
docs/agent-naming-guidance
Feb 22, 2026
Merged

docs: add explicit naming guidance to AGENTS#134
benvinegar merged 1 commit into
mainfrom
docs/agent-naming-guidance

Conversation

@benvinegar
Copy link
Copy Markdown
Member

Summary

Add repo-wide agent guidance for naming clarity in code.

Changes

  • Prefer explicit, domain-aware names for shared code.
  • Keep action names semantic.
  • Use storage/runtime qualifiers for read/write helpers when useful.
  • Allow lighter local variable names only when scope is short and context is obvious.

Scope

  • AGENTS.md only

Behavior

Documentation-only change; no runtime logic changes.

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Feb 22, 2026

Greptile Summary

Adds explicit naming guidance to the "Strong defaults" section of AGENTS.md. The new guidelines encourage domain-aware names for shared code (e.g., SlackWorkspaceKVRecord), semantic action names with storage qualifiers for read/write helpers (e.g., getWorkspaceKVRecord), and allow lighter local variable names in short scopes while warning against ambiguous names like data or payload when crossing boundaries.

  • Clear, actionable naming conventions with concrete examples
  • Well-integrated into existing documentation structure
  • No issues found

Confidence Score: 5/5

  • This PR is safe to merge with no risk
  • Documentation-only change that adds clear, well-structured naming guidance with concrete examples. No runtime logic changes, no security implications, and the guidance aligns with common best practices
  • No files require special attention

Important Files Changed

Filename Overview
AGENTS.md Added clear naming conventions for shared code, actions, and local variables with helpful examples

Last reviewed commit: ed10a61

@benvinegar benvinegar merged commit 85d955a into main Feb 22, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant