به هسته کمک کنید

مخزن اصلی Blockly شامل کدی است که برای اجرای هر برنامه مبتنی بر Blockly مورد نیاز است.

نیاز به دانستن

در اینجا مروری سریع بر حقایقی در مورد هسته Blockly که برای ایجاد PR باید بدانید، ارائه شده است.

  • شاخه‌ی فعال، شاخه‌ی اصلی است و تمام PRها باید در مقابل شاخه‌ی اصلی ساخته شوند.
  • شما باید الگوی درخواست pull را با اطلاعات درخواستی پر کنید.
  • کد باید با راهنمای سبک TypeScript گوگل مطابقت داشته باشد.
  • از کامیت‌های مرسوم در پیام‌های کامیت و عناوین درخواست‌های pull خود استفاده کنید.
  • رشته‌های قابل مشاهده توسط کاربر باید در فایل /msg/messages.js باشند تا بتوان آنها را ترجمه کرد. کمتر از ۶٪ از مردم جهان به زبان مادری انگلیسی صحبت می‌کنند.
  • متن روی بلوک‌ها معمولاً باید تماماً با حروف کوچک باشد (درست مانند کلمات کلیدی در اکثر زبان‌های برنامه‌نویسی).
  • سازگاری با نسخه‌های قبلی را حفظ کنید. برنامه‌های Blockly زیادی وجود دارند، بقیه را خراب نکنید.

  • هر فایل کد جدید باید با پیشوند Apache License v2.0 شروع شود:

    /**
 *   @license
 *   Copyright <Current YYYY> Google LLC
 *   SPDX-License-Identifier: Apache-2.0
 */

ایجاد و تأیید تغییر

  1. برای نصب وابستگی‌ها npm install اجرا کنید.
  2. برای راه‌اندازی سروری که playground را اجرا می‌کند، npm run start اجرا کنید. می‌توانید از این صفحه برای آزمایش رفتار موجود استفاده کنید. برای اطلاعات بیشتر به صفحه playground مراجعه کنید.
  3. هرگونه تغییر لازم را در کد اعمال کنید.
  4. اگر سرور را در حال اجرا رها کرده‌اید، برای مشاهده تغییرات، آن را رفرش کنید. در غیر این صورت، سرور را مجدداً راه‌اندازی کنید و بررسی کنید که کد مطابق انتظار عمل می‌کند و هیچ خطا یا هشداری در کنسول وجود ندارد.
  5. دستور npm run build اجرا کنید و مطمئن شوید که هیچ خطایی در ساخت وجود ندارد.
  6. تست‌های خودکار بنویسید. معمولاً این تست‌ها، تست‌های mocha در دایرکتوری tests/mocha هستند، اما ممکن است از شما انواع دیگری از تست‌ها را بخواهیم.
  7. دستور npm run format اجرا کنید تا کد را قالب‌بندی کند و به طور خودکار برخی از مشکلات lint را برطرف کند.
  8. برای اجرای تست‌های خودکار npm test اجرا کنید. این دستور همچنین eslint را اجرا می‌کند.
  9. اگر خطاهای lint وجود دارد، دستور npm run lint:fix تا مشکلاتی که به صورت خودکار قابل رفع هستند، برطرف شوند. به هرگونه هشدار یا خطای lint باقی مانده رسیدگی کنید.
  10. اگر همه تست‌ها با موفقیت انجام شوند، شما آماده‌اید تا یک PR در برابر main با تغییرات خود باز کنید.