Skip to content

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

Merged
dkhawk merged 2 commits into
mainfrom
docs/agents-md
Sep 8, 2026
Merged

docs: add AGENTS.md guidance for AI coding agents#1773
dkhawk merged 2 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. Also adds a one line CLAUDE.md pointer so Claude Code picks up the same file.

Content

  • Table of the modular layout (library, clustering, heatmaps, data, ui, maps-utils aggregator, lint-checks, demo, visual-testing) with a pointer to MIGRATION.md
  • Build, test and lint commands
  • API key setup for the demo app
  • Code style rules: match the language of the file being edited, .editorconfig formatting, API compatibility expectations, and placing changes in the most specific submodule
  • PR conventions, including that release-please parses Conventional Commit prefixes and that CHANGELOG.md and the release manifest are machine generated
  • The AI contribution policy from CONTRIBUTING.md

Note: bom/ and collections/ are tracked with build files but are not currently wired into settings.gradle.kts, so they are left out of the module table for now.

This gives contributors using any coding agent one canonical instructions file, in line with the standardization discussion in googlemaps-samples/android-maps3d-samples#62.

@googlemaps-bot

Copy link
Copy Markdown
Contributor

Code Coverage

Overall Project 50.4% 🍏

There is no coverage information present for the Files changed

@dkhawk
dkhawk merged commit db87f3c into main Sep 8, 2026
12 checks passed
@dkhawk
dkhawk deleted the docs/agents-md branch September 8, 2026 21:12
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.

3 participants