Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 2.18 KB

Contributing

Before code can be accepted, all contributors must complete our Individual Contributor License Agreement (CLA).

Build

This project uses Git submodules to build our branch of AndroidX Paging alongside our common API declarations.

You'll need to run these commands before you can build:

git submodule update --init --remote

The primary branches are:

  • androidx-main-${version} – a pruned fork of AndroidX containing the multiplatformized paging-common and paging-runtime code at the specified AndroidX Paging version. For example, androidx-main-3.1.1 is a multiplatformized version of AndroidX Paging 3.1.1.
  • main – contains type aliases to the multiplatformized code in androidx-main on iOS, and type aliases to the androidx.paging:paging-X artifact on JVM. The submodule upstreams/androidx-main-${version} points to the respective androidx-main-${version} branch.

Add support for another AndroidX Paging release

  1. Locate the desired release on the AndroidX Paging releases page.
  2. Click the 'Version X contains these commits' link.
  3. Copy the second SHA in the URL. For example, the second SHA in the 3.1.1 release commits would be 65c8f2c53158200a61e0e1cc012cdbbadaee60ab.
  4. git fetch https://android.googlesource.com/platform/frameworks/support ${COPIED_SHA}
  5. git switch -c androidx-main-${X} ${COPIED_SHA}.
  6. Cherry-pick the Multiplatform Paging commits from androidx-main-${Y} onto androidx-main-${X}. Y should be the version closest to X.

IntelliJ IDEA Optional plugins

  • Compose Multiplatform IDE Support - This adds support for IDE preview of composable functions marked by @Preview annotations