APKLife

Contributing to APKLife (EN)

1) Environment setup

Linux/macOS

python -m venv .venv
source .venv/bin/activate
pip install -r requirements-dev.txt

Windows (PowerShell)

python -m venv .venv
.\.venv\Scripts\Activate.ps1
pip install -r requirements-dev.txt

2) Run locally

make run

3) Quality checks

make test
make lint

4) Branching strategy

• Branch from main with feature/<topic> or fix/<topic>.
• Keep commits focused and atomic.
• Rebase your branch on top of origin/main before PR.

5) Pull request expectations

• Explain motivation and technical approach.
• Include validation commands and outcomes.
• Update docs when behavior/config changes.
• Ensure no secrets/tokens are committed.

6) Coding expectations

• Use Black formatting.
• Pass Ruff and Mypy checks.
• Keep service modules cohesive (single responsibility).
• Avoid wildcard imports.

7) Useful links

• Main docs: README.en.md
• Architecture: docs/ARCHITECTURE.en.md
• Code of Conduct: CODE_OF_CONDUCT.en.md