مشارکت در توسعه
روند عملی برای تغییرات متمرکز، قابل بازتولید و اعتبارسنجیشده.
مستندات ESPFlight · v1 • مسیر رسمی و تستشده برای v1
# روند مشارکت
- از repository و مبنای مرجع درست شروع کنید. برای component موردنظر fork/branch بسازید و tag یا commit آغاز کار را ثبت کنید.
- مشکل را بازتولید یا دقیق تعریف کنید. رفتار فعلی، رفتار مورد انتظار، فرضهای سختافزاری و دلیل نیاز به تغییر را توضیح دهید.
- تغییر را متمرکز نگه دارید. قالببندی، بازآرایی کد یا تغییر سختافزاری نامرتبط را بدون ضرورت وارد همان بازبینی نکنید.
- ساخت و اعتبارسنجی انجام دهید. از toolchain مستندشده استفاده کنید. تغییرات مؤثر بر پرواز باید بدون ملخ اعتبارسنجی شوند؛ اگر رفتار فقط در پرواز قابل سنجش است، نتیجه تست کنترلشده را نیز ارائه کنید.
- اثر سازگاری را مستند کنید. تغییر Protocol، pin، hardware، license، configuration یا safety را صریح اعلام کنید.
- Pull Request باز کنید. مراحل بازتولید، نتیجه اعتبارسنجی، گزارش/تصویر صفحه لازم و محیط دقیق تست را اضافه کنید.
ایمنی
کامپایل موفق به معنی اعتبارسنجی پرواز نیست. هر تغییری که بتواند بر خروجی موتور، وضعیت پرواز، سنسورها، failsafe یا شبکه اثر بگذارد باید متناسب با ریسک خود شواهد اعتبارسنجی داشته باشد.
# چکلیست Review
مشکل و رفتار مورد انتظار روشن است.
tag/commit، revision برد، toolchain و libraryها مشخصاند.
تغییرات نامرتبط حذف شدهاند.
فرضهای سختافزاری و شرایط تست ثبت شدهاند.
نتیجه bench test و در صورت نیاز controlled flight موجود است.
تغییرهای Protocol و compatibility مشخص شدهاند.