Skip to content

fa CONTRIBUTING

github-actions[bot] edited this page Nov 17, 2026 · 5 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 | 中文


مشارکت در VD Dropbear

از علاقهٔ شما سپاسگزاریم. این یک پروژهٔ کوچک و حساس به امنیت است (دسترسی root را واگذار می‌کند)، پس تغییرات با در نظر گرفتن همین نکته بازبینی می‌شوند.

چیدمان مخزن

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)

ساخت

باینری توسط CI از mkj/dropbear upstream به‌علاوهٔ وصله‌های موجود در patches/ تولید می‌شود. برای ساخت محلی به Android NDK نیاز دارید:

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

مجموعهٔ وصله‌ها عمداً حداقلی و قابل‌ممیزی است: یک رشتهٔ هویت خنثی/قابل‌پیکربندی، مسیرهای هدایت‌شده با پیکربندی برای authorized_keys و فایل رمز عبور، اصلاح openpty اندروید، و پیکربندی در زمان اجرا. لطفاً وصله‌های جدید را کوچک، مستند و توجیه‌شده در PR نگه دارید.

Pull requestها

  • یک تغییر منطقی در هر PR؛ انگیزه و تأثیر امنیتی را شرح دهید.
  • سبک شل موجود را رعایت کنید (POSIX sh / mksh اندروید؛ بدون bashism).
  • هر فایل یک سربرگ کوتاه SPDX دارد. آن را نگه دارید.
  • CHANGELOG.md را زیر [Unreleased] برای هر تغییر واقعی و قابل‌مشاهده برای کاربر به‌روز کنید.
  • با ارسال یک PR موافقت می‌کنید که مشارکت خود را تحت مجوز Apache-2.0 پروژه منتشر کنید.

ترجمه‌ها

README و مستندات در زبان‌های بسیاری نگهداری می‌شوند (README.<lang>.md). انگلیسی منبع حقیقت است؛ ترجمه‌ها از آن پیروی می‌کنند. اگر ترجمه‌ای را بهبود دادید یا زبانی افزودید، ساختار و لنگرهای بخش را عیناً مانند نسخهٔ انگلیسی نگه دارید.

گزارش باگ‌ها و مسائل امنیتی

برای باگ‌ها و درخواست‌های ویژگی از قالب‌های مسئله استفاده کنید. برای هر چیزی که می‌تواند یک دستگاه را به خطر بیندازد، از SECURITY.md پیروی کنید و به‌جای گشودن یک مسئلهٔ عمومی، آن را خصوصی گزارش دهید.


این مستندات با Claude (Anthropic) تولید شده و توسط VD171 نگهداری می‌شود. اصلاحات و بهبودها خوش‌آمد است؛ به CONTRIBUTING.md مراجعه کنید.

Clone this wiki locally