-
Notifications
You must be signed in to change notification settings - Fork 262
Create AGENTS.md with project documentation #191
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
riggaroo
wants to merge
4
commits into
main
Choose a base branch
from
agents-file
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+73
−0
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # AGENTS.md | ||
|
|
||
| ## Project Overview | ||
| **Androidify** is an Android application that allows users to create custom Android bot avatars using AI. It leverages modern Android technologies and integrates with Google's Gemini models for generative AI features. | ||
|
|
||
| ## Technology Stack | ||
| - **Language**: Kotlin | ||
| - **UI Framework**: Jetpack Compose | ||
| - **Architecture**: MVVM / Clean Architecture guidelines (implied by `core`, `feature`, `data` structure) | ||
| - **AI/ML**: | ||
| - Gemini API (via Firebase AI Logic SDK) | ||
| - Imagen models | ||
| - **Camera**: CameraX | ||
| - **Navigation**: Navigation 3 (Compose) | ||
| - **Dependency Injection**: Hilt (implied by `libs.plugins.hilt` in build.gradle) | ||
| - **Build System**: Gradle (Kotlin DSL) | ||
|
|
||
| ## Project Structure | ||
| The project follows a modularized architecture: | ||
|
|
||
| - **`/app`**: The main Android application module. Connects features and configures the app. | ||
| - **`/core`**: Core libraries and utilities shared across modules (e.g., `core/network`, `core/util`). | ||
| - **`/feature`**: Feature-specific modules (e.g., `feature/home`, `feature/creation`). | ||
| - **`/data`**: Data layer repositories and datasources. | ||
| - **`/wear`**: Wear OS specific module. | ||
| - **`/watchface`**: Watch face module for Wear OS. | ||
| - **`/setup`**: Scripts and configuration files for setting up the project (e.g., Firebase Remote Config). | ||
|
|
||
| ## Development Workflow | ||
|
|
||
| ### Prerequisites | ||
| - Android Studio (Latest Stable or Preview as needed for bleeding edge features) | ||
| - JDK 17+ (Standard for modern Android dev) | ||
| - `google-services.json` placed in `/app` (See `README.md` for setup). | ||
|
|
||
| ### Common Commands | ||
|
|
||
| **Build:** | ||
| ```bash | ||
| ./gradlew assembleDebug | ||
| ``` | ||
|
|
||
| **Test:** | ||
| ```bash | ||
| # Unit tests | ||
| ./gradlew test | ||
|
|
||
| # Instrumented tests | ||
| ./gradlew connectedAndroidTest | ||
| ``` | ||
|
|
||
| **Code Formatting & Linting:** | ||
| This project uses **Spotless** for code formatting. | ||
|
|
||
| ```bash | ||
| # Check for formatting issues | ||
| ./gradlew spotlessCheck | ||
|
|
||
| # Apply formatting fixes | ||
| ./gradlew spotlessApply | ||
| ``` | ||
|
|
||
| ### Configuration | ||
| - **Firebase**: Requires a valid `google-services.json`. | ||
| - **Remote Config**: Defaults found in `core/network/src/main/res/xml/remote_config_defaults.xml`. | ||
| - **API Keys**: Managed via `local.properties` or build config fields (check specific module `build.gradle.kts` for details). | ||
|
|
||
| ## Key Guidelines for Agents | ||
| 1. **Compose First**: adhere to modern Jetpack Compose best practices. | ||
| 2. **Modularization**: Respect the module boundaries. Core modules should not depend on features. | ||
| 3. **Spotless**: Always run `spotlessApply` on modified files if possible, or ensure code aligns with the project's style guide. | ||
| 4. **AI Features**: When working on AI features, refer to the Firebase AI Logic SDK documentation and established patterns in the codebase. | ||
| 5. **Large Screen**: The app is a Tier 1 example of Large screen guidelines, meaning its fully optimized for different screen sizes. When performing any changes, ensure it works across the specrtrum of Android devices. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.