Skip to content

Commit d340880

Browse files
docs: add the Kotlin migration playbook and tracker
Adds docs/kotlin-migration/PLAYBOOK.md, which sets out the rules for converting android-core and android-kit-base internals from Java to Kotlin without changing the published API: what stays Java and why, the compatibility tiers and the check that proves each, the conversion rules, the per-PR checklist, risk classes and merge rules, and the ProGuard protocol. Adds docs/kotlin-migration/TRACKER.md with every planned pull request by phase and stack, and points AGENTS.md at both. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
1 parent 42a659c commit d340880

3 files changed

Lines changed: 359 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@ Environment setup, the Maven-local workflow and the isolated-kit builds are in
1010
[CONTRIBUTING.md](CONTRIBUTING.md). API reference lives in the
1111
[public docs](https://docs.mparticle.com/developers/sdk/android/).
1212

13+
## Before you touch `android-core/src/main` or `android-kit-base/src/main`
14+
15+
A Java to Kotlin migration of the SDK internals is in progress. Read
16+
[docs/kotlin-migration/PLAYBOOK.md](docs/kotlin-migration/PLAYBOOK.md) first: it defines what stays
17+
Java, the conversion rules that keep the compiled API identical, the per-PR checklist and the
18+
risk classes. [docs/kotlin-migration/TRACKER.md](docs/kotlin-migration/TRACKER.md) lists the pull
19+
requests and their status.
20+
1321
## What this repo is
1422

1523
A public, multi-module Gradle library published to Maven Central, plus the integration kits that

0 commit comments

Comments
 (0)