Skip to content

Update AGENTS rules #22

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.

Sign up for GitHub

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

Merged
AlexGladkov merged 1 commit into from
May 21, 2025
Merged

Update AGENTS rules #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# AGENTS Instructions

## Project architecture
- This repository contains a Compose Multiplatform project. The core module is `composeApp`.
- Platform specific sources live under `composeApp/src/<platform>Main/` (e.g. `androidMain`, `iosMain`).
- The `iosApp` directory contains the Xcode project for iOS. The `kotlin-js-store` directory only holds web dependencies.
- Keep changes scoped to the relevant module or folder. Avoid touching unrelated modules when fixing or adding functionality.

## Kotlin development rules
- Use **four spaces** for indentation.
- Follow Kotlin naming conventions: `PascalCase` for classes and objects, `camelCase` for functions and variables.
- Provide explicit return types on public functions.
- Document public classes and functions using KDoc comments.
- Prefer immutable data (`val` and data classes) when possible.
- Try to keep line length under **120 characters**.
- Delete unused imports if they exist.

## Working with the project
- Before committing code, run `./gradlew build` to ensure the project compiles.
- Only update `iosApp` or `kotlin-js-store` when a change explicitly targets these folders.
Loading