Skip to content

A rootless Android app that boots Alpine Linux: run containers (Podman/Docker/LXC) and GUI desktop apps.

Rewrite CONTRIBUTING.md with correct links and instructions

ExTv6f41489c5d70
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6103121..224fd5e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,95 +1,58 @@
# Contributing to Podroid
-Thank you for your interest in contributing! Podroid is a fully open source project and
-welcomes contributions of all kinds.
+Contributions are welcome! Whether it's a bug report, feature idea, or code change — all help is appreciated.
----
-
-## Ways to Contribute
-
-- **Bug reports** — Open an issue with steps to reproduce
-- **Feature requests** — Open an issue describing the feature and its motivation
-- **Code** — Submit a pull request (see below)
-- **Documentation** — Improve README, inline docs, or wiki pages
-- **Testing** — Test on different devices and report results
-
----
-
-## Development Setup
+## Getting Started
1. Clone the repo:
- ```bash
- git clone https://github.com/excp/Podroid
+ ```sh
+ git clone https://github.com/ExTV/Podroid.git
cd Podroid
```
-2. Build QEMU:
- ```bash
- export ANDROID_NDK_HOME=/path/to/ndk
- ./scripts/build-qemu.sh
+2. Build the initramfs (requires Docker with multi-arch support):
+ ```sh
+ ./docker-build-initramfs.sh
```
-3. Open in Android Studio (Ladybug or newer)
-
-4. Build and run on an ARM64 Android device (API 34+)
-
----
-
-## Code Style
-
-- **Kotlin**: Follow the official [Kotlin coding conventions](https://kotlinlang.org/docs/coding-conventions.html)
-- **C/JNI**: Follow the existing style in `app/src/main/jni/`
-- Use `ktlint` for formatting: `./gradlew ktlintFormat`
-- All public functions and classes must have KDoc documentation
-
----
-
-## Pull Request Guidelines
+3. Open in Android Studio and build, or from the command line:
+ ```sh
+ ./gradlew assembleDebug
+ adb install -r app/build/outputs/apk/debug/app-debug.apk
+ ```
-1. Fork the repository and create a branch: `feature/your-feature` or `fix/your-bug`
-2. Write tests for new functionality where applicable
-3. Ensure all existing tests pass: `./gradlew test`
-4. Keep pull requests focused — one feature or fix per PR
-5. Update documentation if your change affects user-facing behavior
-6. Add yourself to CREDITS.md if you haven't contributed before
+You need an **arm64 Android device** running **Android 14+** to test.
----
+## Reporting Bugs
-## Commit Message Format
+Open an [issue](https://github.com/ExTV/Podroid/issues) with:
+- Steps to reproduce
+- What you expected vs what happened
+- Device model and Android version
+- Relevant logcat output (`adb logcat --pid=$(adb shell pidof com.excp.podroid.debug)`)
-```
-type(scope): short description
+## Submitting Changes
-Longer description if needed. Explain WHY, not WHAT.
+1. Fork the repo and create a branch (`fix/your-bug` or `feature/your-feature`)
+2. Keep PRs focused — one fix or feature per PR
+3. Test on a real device before submitting
+4. Update the README if your change affects user-facing behavior
-Fixes #123
-```
+## Project Structure
-Types: `feat`, `fix`, `docs`, `refactor`, `test`, `build`, `chore`
+- `init-podroid` — VM init script (Alpine Linux boot, overlay setup, getty)
+- `Dockerfile` / `docker-build-initramfs.sh` — initramfs build pipeline
+- `app/src/main/java/com/excp/podroid/engine/` — QEMU lifecycle, QMP client, VM state
+- `app/src/main/java/com/excp/podroid/service/` — Android foreground service
+- `app/src/main/java/com/excp/podroid/ui/` — Jetpack Compose UI (Home, Terminal, Settings)
+- `app/src/main/jniLibs/` — Pre-built QEMU and libslirp binaries
-Examples:
-```
-feat(vnc): add ZRLE encoding support for faster display updates
-fix(engine): prevent crash when QEMU exits before VNC connects
-docs(readme): update build instructions for NDK r27
-```
+## Code Style
----
+- Follow standard [Kotlin conventions](https://kotlinlang.org/docs/coding-conventions.html)
+- Keep it simple — no unnecessary abstractions or premature optimization
+- Match the existing style of the file you're editing
## License
-By contributing to Podroid, you agree that your contributions will be licensed under the
-**GNU General Public License v2.0** (or later), the same license as the project.
-
----
-
-## Attribution
-
-All contributors are credited in [CREDITS.md](CREDITS.md). Please add your name in your
-first pull request.
-
----
-
-## Code of Conduct
-
-Be respectful and constructive. We are all here to build something great together.
+By contributing, you agree that your work will be licensed under the **GNU General Public License v2.0**, the same license as the project.