Skip to content

Commit 30a5af5

Browse files
authored
Merge pull request #1920 from SimonMarquis/patch-5
Improve AGENT.md
2 parents 1c5cd5c + 39d8454 commit 30a5af5

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

AGENT.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ available, and bookmark items.
99
This project is a modern Android application that follows the official architecture guidance from Google. It is a reactive, single-activity app that uses the following:
1010

1111
- **UI:** Built entirely with Jetpack Compose, including Material 3 components and adaptive layouts for different screen sizes.
12-
- **State Management:** Unidirectional Data Flow (UDF) is implemented using Kotlin Coroutines and Flows. ViewModels act as state holders, exposing UI state as streams of data.
12+
- **State Management:** Unidirectional Data Flow (UDF) is implemented using Kotlin Coroutines and `Flow`s. `ViewModel`s act as state holders, exposing UI state as streams of data.
1313
- **Dependency Injection:** Hilt is used for dependency injection throughout the app, simplifying the management of dependencies and improving testability.
1414
- **Navigation:** Navigation is handled by Jetpack Navigation 2 for Compose, allowing for a declarative and type-safe way to navigate between screens.
1515
- **Data:** The data layer is implemented using the repository pattern.
@@ -18,11 +18,12 @@ This project is a modern Android application that follows the official architect
1818
- **Background Processing:** WorkManager is used for deferrable background tasks.
1919

2020
## Modules
21-
The main Android app lives in the `app/` folder. Feature modules live in "feature/" and core and shared modules in "core/".
21+
22+
The main Android app lives in the `app/` folder. Feature modules live in `feature/` and core and shared modules in `core/`.
2223

2324
## Commands to Build & Test
2425

25-
The app and Android libraries have two product flavors: `demo` and `prod`.
26+
The app and Android libraries have two product flavors: `demo` and `prod`, and two build types: `debug` and `release`.
2627

2728
- Build: `./gradlew assemble{Variant}`. Typically `assembleDemoDebug`.
2829
- Fix linting/formatting: `./gradlew --init-script gradle/init.gradle.kts spotlessApply`
@@ -38,14 +39,14 @@ The app and Android libraries have two product flavors: `demo` and `prod`.
3839

3940
#### Instrumented tests
4041

41-
- Tests for UI features should only use ComposeTestRule with a ComponentActivity.
42-
- Bigger tests live in :app and they can start activities like MainActivity.
42+
- Tests for UI features should only use `ComposeTestRule` with a `ComponentActivity`.
43+
- Bigger tests live in the `:app` module and they can start activities like `MainActivity`.
4344

4445
#### Local tests
4546

46-
- Kotlinx Coroutines for most assertions
47-
- Turbine for complex coroutine tests
48-
- Truth for assertions
47+
- [kotlinx.coroutines](https://github.com/Kotlin/kotlinx.coroutines) for most assertions
48+
- [cashapp/turbine](https://github.com/cashapp/turbine) for complex coroutine tests
49+
- [google/truth](https://github.com/google/truth) for assertions
4950

5051
## Continuous integration
5152

@@ -54,4 +55,4 @@ The app and Android libraries have two product flavors: `demo` and `prod`.
5455

5556
## Version control and code location
5657

57-
- The project uses git and is hosted in github.com/android/nowinandroid.
58+
- The project uses git and is hosted in https://github.com/android/nowinandroid.

0 commit comments

Comments
 (0)