From 9c696d6ff8eb78f7f59470d72b61ca7686adc161 Mon Sep 17 00:00:00 2001 From: topjohnwu Date: Tue, 7 Apr 2026 03:26:55 -0700 Subject: [PATCH] Add basic AGENTS.md for application code --- AGENTS.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 000000000..ee906336b --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,12 @@ +## AGENTS.md for Magisk + +### General + +- Prefix every shell command with `scripts/env.py` to ensure that commands are executed with the correct environment. + +### App + +- All application related source code lives under `app` directory. When working on the application codebase, use `app` as the working directory. +- The `app` directory is itself a Gradle project. Use `./gradlew` with corresponding tasks to build the app. +- The Magisk app is written in Kotlin and Java. Prefer Kotlin for all new code. +- After doing changes in `app`, make sure to build the relevant modules to ensure they build successfully.