Skip to content

docs: add AGENTS.md guidance for AI coding agents - #2414

Merged
kikoso merged 3 commits into
mainfrom
docs/agents-md
Sep 8, 2026
Merged

docs: add AGENTS.md guidance for AI coding agents#2414
kikoso merged 3 commits into
mainfrom
docs/agents-md

Conversation

@kikoso

@kikoso kikoso commented Sep 8, 2026

Copy link
Copy Markdown
Collaborator

Overview

Adds an AGENTS.md at the repo root with guidance for AI coding agents working on this repository, following the agents.md convention, plus a one line CLAUDE.md pointer so Claude Code picks up the same file. Companion to googlemaps/android-maps-compose#993 and googlemaps/android-maps-utils#1773.

Content

  • Map of the repo areas (ApiDemos, snippets, tutorials, FireMarkers, WearOS)
  • A dedicated section on the snippets modules: the [START]/[END] region tags feed the documentation site, so agents must not rename tags or reformat tagged code, and Java/Kotlin snippet modules must stay in sync
  • The same parity rule for ApiDemos java-app and kotlin-app
  • Build commands including scripts/verify_all.sh, and the API key setup via local.defaults.properties / local.properties
  • PR conventions, including that release-please parses Conventional Commit prefixes and CHANGELOG.md is machine generated
  • A pointer to the AI-assisted contribution policy already in CONTRIBUTING.md

Samples repos receive a growing share of AI-generated contributions, and the snippets-to-docs pipeline is exactly the kind of non-obvious constraint agents break without written guidance.

@snippet-bot

snippet-bot Bot commented Sep 8, 2026

Copy link
Copy Markdown

No region tags are edited in this PR.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

@kikoso
kikoso merged commit 2410cfe into main Sep 8, 2026
16 checks passed
@kikoso
kikoso deleted the docs/agents-md branch September 8, 2026 16:42
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.

2 participants