Google Git
Sign in
android / platform / frameworks / support / 79a2e7c9e6d60bf44538914763ad4b9ce39db3ef
commit79a2e7c9e6d60bf44538914763ad4b9ce39db3ef[log] [tgz]
authorAndroidX Core Team <[email protected]>Tue Sep 26 14:22:02 2023 -0700
committerAndroidX Core Team <[email protected]>Tue Sep 26 14:22:52 2023 -0700
tree154ff961d016678d1aa682becfc6b40ecb0d200a
parentff4d4370077b3f754091e00f4355b4671e0c47b6 [diff]
Add functionality guidelines

We don't want people embedding ads or metrics in libraries unless
they are ads or metrics libraries, respectively.

Also includes a partial acknowledgement that the API Guidelines
cover more than just client-facing APIs.

PiperOrigin-RevId: 568647921
Change-Id: I98f892964298fc971a13190ce137cee81eb6a5b4
3 files changed
tree: 154ff961d016678d1aa682becfc6b40ecb0d200a
  1. .github/
  2. .idea/
  3. activity/
  4. annotation/
  5. appactions/
  6. appcompat/
  7. appintegration/
  8. appsearch/
  9. arch/
  10. asynclayoutinflater/
  11. autofill/
  12. benchmark/
  13. biometric/
  14. bluetooth/
  15. browser/
  16. buildSrc/
  17. buildSrc-tests/
  18. busytown/
  19. camera/
  20. car/
  21. cardview/
  22. collection/
  23. compose/
  24. concurrent/
  25. constraintlayout/
  26. contentpager/
  27. coordinatorlayout/
  28. core/
  29. credentials/
  30. cursoradapter/
  31. customview/
  32. datastore/
  33. development/
  34. docs/
  35. docs-public/
  36. docs-tip-of-tree/
  37. documentfile/
  38. draganddrop/
  39. drawerlayout/
  40. dynamicanimation/
  41. emoji/
  42. emoji2/
  43. enterprise/
  44. exifinterface/
  45. external/
  46. fragment/
  47. frameworks/
  48. glance/
  49. gradle/
  50. graphics/
  51. gridlayout/
  52. health/
  53. heifwriter/
  54. hilt/
  55. input/
  56. inspection/
  57. interpolator/
  58. javascriptengine/
  59. kruth/
  60. leanback/
  61. lifecycle/
  62. lint-checks/
  63. loader/
  64. media/
  65. media2/
  66. mediarouter/
  67. metrics/
  68. navigation/
  69. paging/
  70. palette/
  71. percentlayout/
  72. placeholder/
  73. placeholder-tests/
  74. playground-common/
  75. preference/
  76. print/
  77. privacysandbox/
  78. profileinstaller/
  79. recommendation/
  80. recyclerview/
  81. remotecallback/
  82. resourceinspection/
  83. room/
  84. safeparcel/
  85. samples/
  86. savedstate/
  87. security/
  88. sharetarget/
  89. slice/
  90. slidingpanelayout/
  91. sqlite/
  92. stableaidl/
  93. startup/
  94. swiperefreshlayout/
  95. test/
  96. testutils/
  97. text/
  98. tracing/
  99. transition/
  100. tv/
  101. tvprovider/
  102. vectordrawable/
  103. versionedparcelable/
  104. viewpager/
  105. viewpager2/
  106. wear/
  107. webkit/
  108. window/
  109. work/
  110. .gitignore
  111. .mailmap
  112. build.gradle
  113. cleanBuild.sh
  114. code-review.md
  115. CONTRIBUTING.md
  116. gradle.properties
  117. gradlew
  118. libraryversions.toml
  119. LICENSE.txt
  120. OWNERS
  121. PREUPLOAD.cfg
  122. README.md
  123. settings.gradle
  124. studiow
  125. TEXT_OWNERS
README.md

Android Jetpack

Revved up by Gradle Enterprise

Jetpack is a suite of libraries, tools, and guidance to help developers write high-quality apps easier. These components help you follow best practices, free you from writing boilerplate code, and simplify complex tasks, so you can focus on the code you care about.

Jetpack comprises the androidx.* package libraries, unbundled from the platform APIs. This means that it offers backward compatibility and is updated more frequently than the Android platform, making sure you always have access to the latest and greatest versions of the Jetpack components.

Our official AARs and JARs binaries are distributed through Google Maven.

You can learn more about using it from Android Jetpack landing page.

Contribution Guide

For contributions via GitHub, see the GitHub Contribution Guide.

Note: The contributions workflow via GitHub is currently experimental - only contributions to the following projects are being accepted at this time:

Code Review Etiquette

When contributing to Jetpack, follow the code review etiquette.

Accepted Types of Contributions

  • Bug fixes - needs a corresponding bug report in the Android Issue Tracker
  • Each bug fix is expected to come with tests
  • Fixing spelling errors
  • Updating documentation
  • Adding new tests to the area that is not currently covered by tests
  • New features to existing libraries if the feature request bug has been approved by an AndroidX team member.

We are not currently accepting new modules.

Checking Out the Code

Head over to the onboarding docs to learn more about getting set up and the development workflow!

Continuous integration

Our continuous integration system builds all in progress (and potentially unstable) libraries as new changes are merged. You can manually download these AARs and JARs for your experimentation.

Password and Contributor Agreement before making a change

Before uploading your first contribution, you will need setup a password and agree to the contribution agreement:

Generate a HTTPS password: https://android-review.googlesource.com/new-password

Agree to the Google Contributor Licenses Agreement: https://android-review.googlesource.com/settings/new-agreement

Getting reviewed

  • After you run repo upload, open r.android.com
  • Sign in into your account (or create one if you do not have one yet)
  • Add an appropriate reviewer (use git log to find who did most modifications on the file you are fixing or check the OWNERS file in the project's directory)

Handling binary dependencies

AndroidX uses git to store all the binary Gradle dependencies. They are stored in prebuilts/androidx/internal and prebuilts/androidx/external directories in your checkout. All the dependencies in these directories are also available from google(), or mavenCentral(). We store copies of these dependencies to have hermetic builds. You can pull in a new dependency using our importMaven tool.