@@ -21,7 +21,7 @@ This project delivers **Stream Chat Android**, a modular SDK spanning low-level
2121- ` *-sample/ ` , ` stream-chat-android-ui-uitests/ ` , ` stream-chat-android-test/ ` – samples, integration, and shared test harnesses
2222- ` buildSrc/ ` , ` config/ ` , ` scripts/ ` , ` fastlane/ ` , ` metrics/ ` – build logic, lint configs, automation, release metrics, CI helpers
2323
24- > Modules are published; avoid leaking internal types across boundaries without coordinating version policy and changelog updates .
24+ > Modules are published; avoid leaking internal types across boundaries without coordinating version policy.
2525
2626## Build, test, and validation
2727- Format/licence: ` ./gradlew spotlessApply ` (auto-fix locally; CI runs ` spotlessCheck ` )
@@ -35,7 +35,7 @@ This project delivers **Stream Chat Android**, a modular SDK spanning low-level
3535Prefer module-scoped tasks while iterating; PRs should pass ` spotlessCheck ` , ` detekt ` , ` apiCheck ` , and relevant unit/UI suites before review.
3636
3737## Coding principles
38- - ** API stability** : Public APIs are validated; favour additive changes and mark deprecations with clear migration paths ( ` DEPRECATIONS.md ` ) .
38+ - ** API stability** : Public APIs are validated; favour additive changes and mark deprecations with clear migration paths.
3939- ** Offline-first** : Respect sync contracts in offline/state modules—guard race conditions, idempotency, and background workers.
4040- ** UI parity** : Keep Compose and XML kits behaviourally aligned; update shared fixtures/tests when touching one side.
4141- ** Performance** : Maintain lazy flows, paging, and baseline profiles; avoid extra recompositions or heavy main-thread work.
@@ -58,7 +58,7 @@ Prefer module-scoped tasks while iterating; PRs should pass `spotlessCheck`, `de
5858
5959## Documentation & comments
6060- Update module README, ` docs/ ` , or API docs when altering setup, themes, or sample flows.
61- - Log deprecations or behavioural shifts in ` CHANGELOG.md ` and ` DEPRECATIONS.md ` .
61+ - Log deprecations or behavioural shifts in release notes via appropriate PR labels .
6262- Keep inline comments focused on intent (why), not mechanics; prefer KDoc for public APIs.
6363
6464## Security & configuration
@@ -67,7 +67,7 @@ Prefer module-scoped tasks while iterating; PRs should pass `spotlessCheck`, `de
6767- Sanitise logs and analytics payloads; follow ` SECURITY.md ` for vulnerability handling.
6868
6969## PR & release hygiene
70- - Target ` develop ` ; main mirrors released artifacts. Sync with release owners before touching versioning, publishing, or changelog scripts.
70+ - Target ` develop ` ; main mirrors released artifacts. Sync with release owners before touching versioning or publishing scripts.
7171- Keep commits imperative (` compose: Prevent duplicate typing indicators ` ) and scoped.
7272- Include test evidence in PR descriptions: Gradle task output, screenshots/screencasts for UI changes.
7373- Run ` assemble ` , relevant tests, and lint tasks locally before pushing. Update documentation alongside feature toggles.
@@ -79,5 +79,5 @@ Prefer module-scoped tasks while iterating; PRs should pass `spotlessCheck`, `de
7979- [ ] Keep Compose/XML parity when modifying shared UI behaviour.
8080- [ ] Run Spotless, Detekt, and ` apiDump ` before finishing.
8181- [ ] Add/refresh unit, UI, or snapshot tests for new behaviour.
82- - [ ] Update changelog/deprecation docs for user-visible changes.
82+ - [ ] Label PRs with appropriate release categories (e.g. ` pr:breaking-change ` ) for user-visible changes.
8383- [ ] Scrub logs/configs for secrets before committing.
0 commit comments