67 lines (44 loc) · 1.79 KB

Contributing to AnyCode

Thanks for your interest in contributing! This guide will help you get started.

💬 Have a question before opening a PR or issue? Join the Discord server — fastest way to reach maintainers and other contributors.

Development Setup

CLI (`any-code-cli/`)

git clone https://github.com/gurudin/anycoding
cd anycoding/any-code-cli
npm install
npm link

Requires Node.js >= 18.

Android (`any-code-android/`)

Open any-code-android/ in Android Studio (Hedgehog+)
JDK 17, Gradle 8.x
Build: ./gradlew assembleDebug
Install: adb install -r app/build/outputs/apk/debug/AnyCode-v*.apk

Branch Strategy

main — stable releases
develop — active development
feat/* — feature branches (branch from develop)

Making Changes

Fork the repo and create a branch from develop
Make your changes
Test locally (build + run on device)
Submit a PR to develop

Commit Messages

No strict convention enforced, but please:

Use a clear, descriptive subject line
Reference related issues when applicable (e.g. fix #12)

Pull Request Process

Describe what your PR does and why
Include screenshots for UI changes
One approval from a maintainer is required to merge

Out of Scope

The following contributions will not be accepted in this repo:

Features related to the cloud relay server (closed source, not in this repo)
Multi-tenant / user account / billing features
Large UI refactors (open an issue to discuss first)

Code Style

Kotlin: follow standard Kotlin conventions
JavaScript: no linter enforced yet, keep it consistent with existing code

Questions?

Open a Discussion or email hc.gaoxiang@gmail.com.