Merge pull request #111 from cheonjaeung/cheon/ai-guidelines

Improve AI agents guideline

Author: cheonjaeung

AGENTS.md

@@ -1,15 +1,21 @@
 # Guidelines for AI Agents
 
+## Overview
+
+This project is a compose multiplatform library to provide advanced grid layout features.
+See `README.md` file and `docs/` directory for more details.
+
 ## Core Rules
 
 - Update documentation when the feature is added, removed or changed.
 - Verify changes by running tests after making changes.
-- Run `./gradlew apiDump` when the public API is changed.
+- Run `./gradlew :grid:apiDump` when the public API is changed.
 - Annotate new public APIs with `@ExperimentalGridApi`.
 
 ## Project Structure
 
 - `grid/`: The main library module.
+  - `api/`: Public API binary compatibility declaration files. Used by the binary compatibility validator to detect breaking API changes.
   - `src/commonMain/`: Main source code for the library.
   - `src/androidMain/`: Android specific source code.
   - `src/test/`: Unit tests and snapshot tests.
@@ -20,11 +26,34 @@
   - `ios/`: Xcode project for iOS sample application.
 - `docs/`: Documentation.
 
-## Commands
+## Common Commands
+
+- `./gradlew :grid:build`: Build project.
+- `./gradlew :grid:test`: Run all test cases.
+- `./gradlew :grid:testDebugUnitTest --tests "TestClassName"`: Run specific tests.
+- `./gradlew :grid:verifyPaparazziDebug`: Run only snapshot tests.
+- `./gradlew :grid:recordPaparazziDebug`: Update and create new snapshots.
+- `./gradlew :grid:apiDump`: Update public API binary compatibility. The result is generated in `grid/api/` directory.
+
+## Key Files
+
+**Library Development**
+
+- `grid/src/commonMain/kotlin/com/cheonjaeung/compose/grid/Grid.kt`: Public layout composables.
+- `grid/src/commonMain/kotlin/com/cheonjaeung/compose/grid/SequentialGridMeasurePolicy.kt`: Core measurement and placing logic of sequential grid (`HorizontalGrid` and `VerticalGrid`).
+- `grid/src/commonMain/kotlin/com/cheonjaeung/compose/grid/GridScopeModifiers.kt`: Custom modifiers of sequential grid (`HorizontalGrid` and `VerticalGrid`).
+- `grid/src/commonMain/kotlin/com/cheonjaeung/compose/grid/BoxGridMeasurePolicy.kt`: Core measurement and placing logic of `BoxGrid`.
+- `grid/src/commonMain/kotlin/com/cheonjaeung/compose/grid/BoxGridScopeModifiers.kt`: Custom modifiers of `BoxGrid`.
+- `grid/src/commonMain/kotlin/com/cheonjaeung/compose/grid/ExtendedGridCells.kt`: Declarations of extended grid cell managements.
+- `grid/src/commonMain/kotlin/com/cheonjaeung/compose/grid/ExperimentalGridApi.kt`: Marker annotation for new experimental APIs.
+
+**Testing**
+
+- `grid/src/test/snapshots/images/`: Recorded snapshots generated by `./gradlew :grid:recordPaparazziDebug`.
+- `grid/build/paparazzi/failures/`: Failed snapshot test result output directory.
+
+**Build Configurations**
 
-- `./gradlew build`: Build project.
-- `./gradlew test`: Run all test cases.
-- `./gradlew testDebugUnitTest --tests "TestClassName"`: Run specific tests.
-- `./gradlew verifyPaparazziDebug`: Run only snapshot tests.
-- `./gradlew recordPaparazziDebug`: Update and create new snapshots.
-- `./gradlew apiDump`: Update public API binary compatibility.
+- `build.gradle.kts`: The project root build script, contains shared build logics.
+- `grid/build.gradle.kts`: Library specific build script, contains dependencies and build logics.
+- `gradle/libs.versions.toml`: Core file for dependency management.