Google Git
Sign in
android / platform / frameworks / support / 6b896e6a827f7357214aa309500585779afa6dc0
commit6b896e6a827f7357214aa309500585779afa6dc0[log] [tgz]
authorTreehugger Robot <[email protected]>Sun Jul 22 19:23:54 2018 +0000
committerGerrit Code Review <[email protected]>Sun Jul 22 19:23:54 2018 +0000
tree30b1f097694c4a53c7a6075334f7eba861911c35
parenta41bee7bfec0a9e4d6e518120856a2588b1da60b [diff]
parenta8417544e408d9f23fbc2ae7143167dc6ed4eda9 [diff]
Merge "Update README.md file to be more up to date with AndroidX." into androidx-master-dev
tree: 30b1f097694c4a53c7a6075334f7eba861911c35
  1. .idea/
  2. annotations/
  3. api/
  4. app-toolkit/
  5. appcompat/
  6. asynclayoutinflater/
  7. benchmark/
  8. biometric/
  9. browser/
  10. buildSrc/
  11. car/
  12. cardview/
  13. collection/
  14. compat/
  15. content/
  16. coordinatorlayout/
  17. core/
  18. cursoradapter/
  19. customview/
  20. development/
  21. docs-fake/
  22. documentfile/
  23. drawerlayout/
  24. dynamic-animation/
  25. emoji/
  26. exifinterface/
  27. fragment/
  28. frameworks/
  29. gradle/
  30. graphics/
  31. gridlayout/
  32. heifwriter/
  33. interpolator/
  34. jetifier/
  35. leanback/
  36. leanback-preference/
  37. legacy/
  38. lifecycle/
  39. loader/
  40. localbroadcastmanager/
  41. media/
  42. media-widget/
  43. media2/
  44. mediarouter/
  45. navigation/
  46. paging/
  47. palette/
  48. percent/
  49. persistence/
  50. preference/
  51. print/
  52. recommendation/
  53. recyclerview/
  54. recyclerview-selection/
  55. room/
  56. samples/
  57. scripts/
  58. slices/
  59. slidingpanelayout/
  60. swiperefreshlayout/
  61. testutils/
  62. testutils-ktx/
  63. textclassifier/
  64. transition/
  65. tv-provider/
  66. versionedparcelable/
  67. viewpager/
  68. viewpager2/
  69. wear/
  70. webkit/
  71. work/
  72. .gitignore
  73. adding-support-library-as-included-build.md
  74. build.gradle
  75. gradle.properties
  76. gradlew
  77. include-composite-deps.gradle
  78. include-support-library.gradle
  79. LICENSE.txt
  80. OWNERS
  81. PREUPLOAD.cfg
  82. README.md
  83. settings.gradle
README.md

AOSP AndroidX Contribution Guide

Accepted Types of Contributions

  • Bug fixes (needs a corresponding bug report in b.android.com)
  • 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

NOTE: You will need to use Linux or Mac OS. Building under Windows is not currently supported.

Follow the “Downloading the Source” guide to install and set up repo tool, but instead of running the listed repo commands to initialize the repository, run the folowing:

repo init -u https://android.googlesource.com/platform/manifest -b androidx-master-dev

Now your repository is set to pull only what you need for building and running Androix libraries. Download the code (and grab a coffee while we pull down 3GB):

repo sync -j8 -c

You will use this command to sync your checkout in the future - it’s similar to git fetch

Using Android Studio

Open path/to/checkout/frameworks/support/ in Android Studio. Now you're ready edit, run, and test!

If you get “Unregistered VCS root detected” click “Add root” to enable git integration for Android Studio.

If you see any warnings (red underlines) run Build > Clean Project.

Builds

Full Build (Optional)

You can do most of your work from Android Studio, however you can also build the full AndroidX library from command line:

cd path/to/checkout/frameworks/support/
./gradlew createArchive

Building AndroidX Libraries as part of your App build

If you intend to repeatedly make changes to AndroidX Libraries and to wish to see the results in your app, and you don't want to have to repeatedly build them as separate Gradle projects, you can configure your app build to build AndroidX Libraries too

Running Tests

Single Test Class or Method

  1. Open the desired test file in Android Studio.
  2. Right-click on a test class or @Test method name and select Run FooBarTest

Full Test Package

  1. In the project side panel open the desired module.
  2. Find the directory with the tests
  3. Right-click on the directory and select Run androidx.foobar

Running Sample Apps

AndroidX libraries has a set of Android applications that exercise AndroidX code. These applications can be useful when you want to debug a real running application, or reproduce a problem interactively, before writing test code.

These applications are named support-*-demos (e.g. support-4v-demos or support-leanback-demos. You can run them by clicking Run > Run ... and choosing the desired application.

Making a change

cd path/to/checkout/frameworks/support/
repo start my_branch_name .
(make needed modifications)
git commit -a
repo upload --current-branch .

If you see the following prompt, choose always:

Run hook scripts from https://android.googlesource.com/platform/manifest (yes/always/NO)?

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)