Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (51 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

72 lines (51 loc) · 2.11 KB
Raw

Contributing to AndCode

Thank you for your interest in contributing!

Getting Started

  1. Fork the repository
  2. Create a feature branch: git checkout -b feat/your-feature
  3. Install the commit-msg hook: ln -sf ../../scripts/commit-msg-hook.sh .git/hooks/commit-msg
  4. Make your changes
  5. Run checks: ./gradlew testDebugUnitTest lintDebug assembleDebug
  6. Commit with a clear message following Conventional Commits
  7. Push and open a Pull Request against main

Commit Message Convention

All commits must follow Conventional Commits:

<type>(<scope>): <description>

Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert

Examples:

  • feat: add voice input support
  • fix(chat): resolve SSE reconnection loop
  • chore: bump dependencies

CI validates commit messages on all PRs.

Development Setup

  • JDK 17 (Temurin recommended)
  • Android SDK (API 34)
  • Python 3 (for runtime asset generation)
  • Network access on first build (downloads Termux packages)

Project Structure

app/src/main/java/com/yugahashimoto/androidcode/
├── data/          # API clients, repositories, models
├── runtime/       # On-device PRoot runtime management
├── ui/            # Jetpack Compose screens and components
└── di/            # Dependency injection

Code Style

  • Kotlin with Jetpack Compose
  • Follow existing patterns in the codebase
  • No comments unless explaining non-obvious logic
  • Prefer immutable data classes and sealed interfaces

Pull Request Guidelines

  • Keep PRs focused on a single change
  • Include tests for new functionality
  • Ensure CI passes (tests, lint, R8 build)
  • Update documentation if behavior changes
  • Screenshots for UI changes are appreciated

Reporting Issues

  • Use the GitHub issue tracker
  • Include device model, Android version, and app version
  • For connection issues, note whether you're using local runtime or remote

License

By contributing, you agree that your contributions will be licensed under the MIT License.