Skip to content

CONTRIBUTING

github-actions[bot] edited this page Nov 17, 2026 · 4 revisions

Languages: English | العربية | Čeština | Deutsch | Español | فارسی | Français | हिन्दी | Bahasa Indonesia | Italiano | 日本語 | 한국어 | Nederlands | Polski | Português | Русский | Svenska | ไทย | Türkçe | Українська | Tiếng Việt | 中文


Contributing to VD Dropbear

Thanks for your interest. This is a small, security-sensitive project (it hands out root), so changes are reviewed with that in mind.

Repository layout

module/     the installable KernelSU / APatch / Magisk module (scripts, WebUI, config, installer)
patches/    the patch set applied on top of upstream Dropbear (the only changes to the SSH server)
src/        where CI unpacks upstream Dropbear to build (not committed)
scripts/    build and maintenance helpers
.github/    CI workflows and issue/PR templates
docs/       documentation (mirrored to the wiki)

Building

The binary is produced by CI from upstream mkj/dropbear plus the patches in patches/. To build locally you need the Android NDK:

scripts/build.sh            # fetches the tracked upstream, applies patches, builds arm64 + arm32

The patch set is intentionally minimal and auditable: a neutral/configurable identity string, config-driven paths for authorized_keys and the password file, the Android openpty fix, and runtime configuration. Please keep new patches small, documented, and justified in the PR.

Pull requests

  • One logical change per PR; describe the motivation and the security impact.
  • Match the existing shell style (POSIX sh / Android mksh; no bashisms).
  • Every file carries a short SPDX header; keep it.
  • Update CHANGELOG.md under [Unreleased] for any real, user-visible change.
  • By submitting a PR you agree to license your contribution under the project's Apache-2.0 license.

Translations

The README and docs are maintained in many languages (README.<lang>.md). English is the source of truth; translations follow it. If you improve a translation or add a language, keep the structure and section anchors identical to the English version.

Reporting bugs and security issues

Use the issue templates for bugs and feature requests. For anything that could compromise a device, follow SECURITY.md and report privately instead of opening a public issue.


This documentation was generated with Claude (Anthropic) and is maintained by VD171. Corrections and improvements are welcome; see CONTRIBUTING.md.

Clone this wiki locally