Skip to content

Repository files navigation

title Contributing

Contributing

Thank you for your interest in contributing to PVZRH Android Launcher!

Getting Started

  1. Fork the repository
  2. Clone your fork
  3. Create a feature branch (git checkout -b feature/my-feature)
  4. Make your changes
  5. Commit and push
  6. Open a Pull Request

Development Environment

  • Android Studio Ladybug or later
  • JDK 17
  • Android SDK with NDK 27.0.12077973 and CMake 3.22.1

Build

$env:ANDROID_HOME="E:\Android\Sdk"; .\gradlew.bat :app:assembleDebug

Output: app/build/outputs/apk/debug/app-debug.apk

Installing to Device

Always uninstall first, then install:

adb uninstall com.pvzrh.android.launcher
adb install app\build\outputs\apk\debug\app-debug.apk

Code Style

  • Kotlin with Jetpack Compose
  • Follow existing patterns in the codebase
  • Keep comments minimal — describe what and why, not how
  • Code comments max 2 lines
  • Summary/class-level comments only

Commit Convention

  • feat: add new feature
  • fix: resolve issue
  • refactor: improve code structure
  • docs: update documentation
  • ci: change CI configuration
  • ui: visual changes

Pull Requests

  • Keep PRs focused on a single change
  • Describe what you changed and why
  • Test on a real device before submitting
  • Ensure the build passes

Reporting Issues

  • Use GitHub Issues
  • Include device model, Android version, and launcher version
  • Attach crash logs if available
  • Describe steps to reproduce

License

By contributing, you agree that your contributions will be licensed under the GPL-3.0 License.

About

No description, website, or topics provided.

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages