Contributing

Thanks for helping improve adbt.

This project is a community effort, and we welcome bug fixes, feature work, and documentation improvements.

Start here

• Read the contributor guide in CONTRIBUTING.md for setup, checks, and pull-request rules.
• Need help or want to ask a question? See SUPPORT.md.
• Looking for a beginner-friendly place to start? Browse the open good first issues.
• By taking part you agree to follow the Code of Conduct.

Local setup

You need Go (see go.mod for the version) and a recent adb (Android SDK Platform Tools) on your PATH. Working on this documentation website also needs Node.js 20 or newer.

git clone https://github.com/<your-username>/adbt.git
cd adbt
go build ./cmd/adbt
./adbt

To preview the documentation website locally:

cd website
npm install
npm start

Before opening a pull request, run gofmt -l . (must print nothing), go vet ./... and go test ./..., and write commit messages in Conventional Commits style. The full checklist lives in CONTRIBUTING.md.

Getting help

• Bugs: open an issue with your adbt version (adbt --version), operating system, phone model and Android version, and the steps to reproduce.
• Security problems: do not post them publicly — follow SECURITY.md.