docs: rewrite AGENTS.md with verified commands and CI requirements#767
Open
jcpsimmons wants to merge 1 commit into
Open
docs: rewrite AGENTS.md with verified commands and CI requirements#767jcpsimmons wants to merge 1 commit into
jcpsimmons wants to merge 1 commit into
Conversation
The previous doc had drifted badly from the codebase: Kotlin 1.8.21 (actual 2.1.21), target SDK 33 (actual 36), Compose BOM 2023.03.00 (actual 2025.10.00), a make install-local-sdk target that does not exist, instructions to branch off a develop branch that does not exist, the wrong test naming convention, and no mention of the location module. Every command and claim in this version was verified against the repo. New: a CI section covering everything that gates a PR (conventional commit title lint, pinned ktlint, per-module Android Lint, apiCheck and how to update dumps, Codecov upload behavior, instrumentation tests, snapshot publish, binary size report), a dependency policy section explaining the deliberate pins, and a CLAUDE.md pointer so Claude Code loads the same guidance.
Sample app builds 📱Below you will find the list of the latest versions of the sample apps. It's recommended to always download the latest builds of the sample apps to accurately test the pull request. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #767 +/- ##
============================================
- Coverage 69.07% 67.89% -1.18%
- Complexity 838 901 +63
============================================
Files 149 159 +10
Lines 4601 4968 +367
Branches 628 670 +42
============================================
+ Hits 3178 3373 +195
- Misses 1189 1341 +152
- Partials 234 254 +20 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
|
📏 SDK Binary Size Comparison ReportNo changes detected in SDK binary size ✅ |
|
Build available to test |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
AGENTS.md had drifted badly from the codebase and would mislead anyone (human or agent) following it: Kotlin 1.8.21 (actual 2.1.21), target SDK 33 (actual 36), Compose BOM 2023.03.00 (actual 2025.10.00), a
make install-local-sdktarget that does not exist, instructions to branch off adevelopbranch that does not exist, the wrong test naming convention, and no mention of thelocationmodule. It also said nothing about most of the checks that actually gate PRs here, like the conventional-commit title lint.What
A full verification pass and rewrite. Every command and claim was checked against the repo (Makefile, gradle files, buildSrc/Versions.kt, lefthook.yml, workflows, scripts).
New:
./gradlew apiDump, unit test matrix and Codecov upload behavior, instrumentation tests, snapshot publish (and why it cannot pass on fork PRs), and the binary size reportlocationmodule is missing from the lint and unit-test CI matrices, so it needs local runsCLAUDE.mdpointer file so Claude Code loads the same guidanceFixes: toolchain versions, local-Maven publish command (
./gradlew publishToMavenLocal), branch-off-main workflow, test naming convention (methodName_givenCondition_expectResult), project structure includinglocation.No internal information; verified suitable for a public repo.
Note
Low Risk
Documentation-only changes to contributor/agent guidance; no runtime, API, or build logic is modified.
Overview
Rewrites
AGENTS.mdso agent and contributor guidance matches the repo after a verification pass against Makefile, Gradle,Versions.kt, hooks, and workflows. Outdated toolchain numbers, a nonexistentmake install-local-sdktarget, branching offdevelop, and the old test naming style are corrected;location/is added to the module map with a note that CI does not lint or unit-test it yet.New or expanded sections include golden rules (build after changes,
apiDump, no drive-by version bumps), a Toolchain block, CI: what gates your PR (eight checks: conventional PR title, pinned ktlint, Android Lint modules,apiCheck/apiDump, unit tests and Codecov, sample instrumentation, snapshot publish on forks, binary size report), Dependency policy (Versions.kt, Segment pin, minSdk 21, AGP workflow coupling), tighter Testing / Git workflow (branch frommain, lefthook, semantic-release), and trimmed architecture/sample/release notes. Long redundant build/test/debug sections are removed in favor of the verified command list.Adds
CLAUDE.mdas a short pointer toAGENTS.md(with@AGENTS.md) so Claude Code loads the same guidance.Reviewed by Cursor Bugbot for commit 969c5e5. Bugbot is set up for automated code reviews on this repo. Configure here.