Files
2026-07-13 12:37:06 +08:00

1.4 KiB

Contributing

Thanks for your interest in MCA.

MCA is an early Android local-first AI workspace. The codebase changes quickly, so contributions should be small, focused, and easy to test.

Development Setup

  1. Install JDK 17.
  2. Install Android SDK, NDK, and CMake versions compatible with gradle/libs.versions.toml.
  3. Clone with submodules:
git clone --recurse-submodules <repo-url>
  1. Build:
./gradlew :app:assembleDebug

On Windows:

.\gradlew.bat :app:assembleDebug

Contribution Guidelines

  • Keep changes scoped to one feature or bug fix.
  • Do not commit API keys, model weights, personal paths, generated APKs, or build outputs.
  • Do not vendor large model files into the repository.
  • Prefer existing UI patterns and module boundaries.
  • Add or update tests when changing shared parsing, download, storage, or native bridge behavior.
  • Clearly label experimental device-specific inference changes.

Local Image Generation

Local image generation is experimental. When changing image engine behavior, please include:

  • Device model and SoC.
  • Model bundle name and component list.
  • Image size, steps, thread count, and elapsed time.
  • Crash logs or native output when applicable.

Pull Request Checklist

  • git status is clean except intended changes.
  • No secrets or private paths are present.
  • Submodules are not accidentally bumped.
  • Build or focused tests were run, or the PR states why they were not.