https://github.com/androidx/androidx

Development environment for Android Jetpack extension libraries under the androidx namespace. Synchronized with Android Jetpack's primary development branch on AOSP.
https://github.com/androidx/androidx

android jetpack library

Last synced: 2 days ago
JSON representation

Development environment for Android Jetpack extension libraries under the androidx namespace. Synchronized with Android Jetpack's primary development branch on AOSP.

• Host: GitHub
• URL: https://github.com/androidx/androidx
• Owner: androidx
• License: apache-2.0
• Created: 2020-04-17T19:17:41.000Z (over 4 years ago)
• Default Branch: androidx-main
• Last Pushed: 2024-10-29T14:58:20.000Z (about 1 month ago)
• Last Synced: 2024-10-29T14:58:50.619Z (about 1 month ago)
• Topics: android, jetpack, library
• Language: Kotlin
• Homepage: https://android.googlesource.com/platform/frameworks/support
• Size: 854 MB
• Stars: 5,336
• Watchers: 138
• Forks: 1,016
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Codeowners: .github/CODEOWNERS
  • Security: security/security-app-authenticator-testing/OWNERS

Awesome Lists containing this project

• awesome-hacking-lists - androidx/androidx - Development environment for Android Jetpack extension libraries under the androidx namespace. Synchronized with Android Jetpack's primary development branch on AOSP. (Kotlin)

README

        
# Android Jetpack

[![Revved up by Develocity](https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A)](https://ge.androidx.dev)

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](https://maven.google.com).

You can learn more about using it from [Android Jetpack landing page](https://developer.android.com/jetpack).

# Contribution Guide

For contributions via GitHub, see the [GitHub Contribution Guide](CONTRIBUTING.md).

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

* [Activity](activity)

* [AppCompat](appcompat)

* [Biometric](biometric)

* [Collection](collection)

* [Compose Runtime](compose/runtime)

* [Core](core)

* [DataStore](datastore)

* [Fragment](fragment)

* [Lifecycle](lifecycle)

* [Navigation](navigation)

* [Paging](paging)

* [Room](room)

* [WorkManager](work)

## Code Review Etiquette

When contributing to Jetpack, follow the [code review etiquette](code-review.md).

## Accepted Types of Contributions

* Bug fixes - needs a corresponding bug report in the [Android Issue Tracker](https://issuetracker.google.com/issues/new?component=192731&template=842428)

* 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](docs/onboarding.md) to learn more about getting set up and the

development workflow!

### Continuous integration

[Our continuous integration system](https://ci.android.com/builds/branches/aosp-androidx-main/grid?) 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](http://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](development/importMaven/README.md).