Skip to content

AGENTS.md

Latest commit

 

History

History
52 lines (36 loc) · 3.07 KB

AGENTS.md

File metadata and controls

52 lines (36 loc) · 3.07 KB

AGENTS.md

Project Overview

This repository contains the open source Tailscale Android client. Tailscale is a private WireGuard® network made easy. The Android client provides seamless VPN connectivity to Tailscale networks on Android devices.

Documentation Index

The following Chinese documentation is available in the docs/ directory:

Common Commands

  • make apk - Build the debug APK
  • make install - Install the APK to a connected device
  • make androidsdk - Install necessary Android SDK components
  • make docker-shell - Start a Docker-based development shell
  • make tag_release - Bump Android version code, update version name, and tag commit

Architecture Highlights

  • Mixed Go and Android/Kotlin development
  • Go code compiled to JNI library for core Tailscale functionality
  • Standard Android project structure with Gradle build system
  • Support for multiple build environments: Android Studio, Docker, Nix

Documentation Maintenance Rules

  • docs/ directory: All documentation in the docs/ directory must be written and maintained in Chinese.
  • PROGRESS.md: The PROGRESS.md file must be written and maintained in Chinese.
  • AGENTS.md: This file (AGENTS.md) must be written and maintained in English.

PROGRESS.md Rules

PROGRESS.md is a sparse, append-only log for high-signal lessons learned, not a routine work log.

  • Only append entries after important bug fixes or significant changes.
  • Never record project initialization, scaffolding generation, documentation-only updates, formatting-only changes, routine configuration tweaks, or other low-signal work.
  • Each entry must be concise and include: problem, solution, prevention, and commitID.
  • The purpose is to help future AI agents and developers avoid repeating the same mistakes.

Development Workflow Rules

  • Version Bump: After modifying any code, the Android version code must be incremented by 1 in android/build.gradle.
  • Build Verification: After modifying any feature or implementation code, make apk must be run and complete successfully before the change can be considered successful.
  • Device Validation: After make apk succeeds for a code change, the updated APK must be installed onto a real Android device and the full end-to-end device test flow must pass before the change can be considered successful.
  • Validation Executor: make apk, APK installation, and real-device test execution must be delegated to the execution_runner subagent instead of the main agent to keep build and device-log noise out of the main context.
  • Validation Model: The execution_runner subagent used for build and device validation must use gpt-5.4-mini to minimize token usage.
⚡