Overview › Documentation & Comments

Documentation & Comments

README is stale; KDoc coverage is low; Dokka configured but underused.

0 findings in this category

SCORE

Summary

The README references SourceTree and an older sync workflow. KDoc coverage is sparse. Dokka is configured but the published docs site is not surfaced.

Findings

HIGH

Stale README

Top-level README.md is legacy.

README.md

Recommendation: Rewrite README to cover: setup with ./gradlew assembleDebug, module map, branching strategy, CI/CD overview, on-call rotation pointer, security contact.

MEDIUM

Low KDoc coverage

Public APIs in shared modules lack KDoc, making cross-module reuse fragile.

Recommendation: Mandate KDoc on public types in shared/*; enforce via Detekt rule UndocumentedPublicClass on shared modules only.

MEDIUM

No ADRs

No docs/adr/ directory. Architectural decisions (BFF adoption, Compose migration, Hilt vs Koin) are undocumented.

Recommendation: Adopt the lightweight MADR format; backfill 5–10 key decisions.

LOW

Per-module READMEs

Each feature/* and shared/* module would benefit from a 1-paragraph README describing its purpose, owners, and public API.

Costco Android · Code Review Report · Generated 2026-05-07 · 626 machine-curated findings