gitea-mirror/Magisk
1
0
Fork 0
mirror of https://github.com/topjohnwu/Magisk.git synced 2026-04-28 03:53:08 -07:00
Code Issues Packages Projects Releases Wiki Activity

Add basic AGENTS.md for application code

Browse Source
This commit is contained in:
topjohnwu
2026-04-07 03:26:55 -07:00
committed by John Wu
parent 240b6db1cc
commit 9c696d6ff8
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
AGENTS.md Normal file
View File

@@ -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.