Skip to content

[LLM] Add AGENTS.md operational contract and agent guide - #4

Merged
menny merged 1 commit into
detekt-aspectfrom
agents-md
Oct 15, 2026
Merged

menny merged 1 commit into
detekt-aspectfrom
agents-md

Conversation

@menny

@menny menny commented Oct 15, 2026

Copy link
Copy Markdown
Member

Summary

Adds AGENTS.md to the repository root establishing explicit operational guardrails, testing workflows, commit standards, and inclusive naming rules adapted from AnySoftKeyboard's guidelines.

Sections Included

  • Verification Gates: Mandatory pre-commit verification steps (format.check, Detekt/Buildifier lint, Bazel tests).
  • Git Commit Guidelines: Concise titles prefixed with [LLM], short issue/solution description, and no AI attribution.
  • Tests: Protocol for test suggestions (Happy path, error cases, edge cases), naming patterns ([OriginalFileName]Test.kt), and preferring fakes over mocks.
  • Naming: Inclusive language rules (e.g. fake/mock/noop, allow-list/disallow-list, gender-neutral pronouns).
  • Prohibitions ("NEVER"): Strict architectural invariants (no Gradle, pure JVM core/* with zero android.* dependencies, no ktlint, push via SSH).
  • Directory Roles & Standard Workflow: Clear package boundaries and feature development lifecycle.

Introduce AGENTS.md in the root directory defining project verification gates, commit message standards, testing guidelines, inclusive naming conventions, and architecture invariants.
@menny
menny merged commit df9c465 into detekt-aspect Oct 15, 2026
1 check 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