همه پروژه های بزرگ بر اساس بازخورد کاربران ساخته شده اند. Blockly از مشکلات GitHub برای ردیابی بازخورد استفاده می کند. این صفحه نحوه نوشتن مشکلی را توضیح می‌دهد که خواندن و پاسخ دادن به آن برای توسعه‌دهنده آسان است، که احتمال رسیدگی به درخواست گزارش اشکال/ویژگی شما را بیشتر می‌کند!
قبل از کار
سوالاتی دارید؟
ما عاشق شنیدن سوالات شما هستیم! اما مشکلات GitHub رسانه خوبی برای آنها نیست. اگر سوالی دارید، به جای آن به انجمن توسعه دهندگان ما سر بزنید. اگر سوال خود را در آنجا بپرسید، به احتمال زیاد پاسخ به موقع و کامل دریافت خواهید کرد، زیرا پر از توسعه دهندگانی است که سال ها از Blockly استفاده می کنند!
موارد تکراری را بررسی کنید
قبل از نوشتن هر نوع موضوعی، همیشه خوب است که ببینید آیا یک مورد مشابه از قبل وجود دارد یا خیر. اگر یکی این کار را انجام دهد، این کار شما را از تلاش برای نوشتن آن صرفه‌جویی می‌کند! بنابراین قبل از شروع نوشتن، برخی موارد تکراری یا مسائل مرتبط را جستجو کنید.
- در نمونه های بلوکی جستجو کنید
- در Blockly core جستجو کنید
- در انجمن جستجو کنید
اگر مشکل منطبق پیدا کردید، آن را مثبت اعلام کنید یا نظر خود را با جزئیات اضافه کنید. این به ویژه برای گزارش های اشکال و درخواست های ویژگی مهم است. اگر توسعه دهندگان ببینند که موضوعی توجه زیادی را به خود جلب کرده است، به احتمال زیاد روی آن کار می شود!
گزارش یک اشکال
پس فکر می کنید یک باگ کشف کرده اید؟ عالی! ما عاشق شنیدن گزارش‌های اشکال هستیم زیرا می‌خواهیم این پروژه تا حد امکان پایدار باشد. در اینجا چند مرحله وجود دارد که می توانید برای کمک به رفع اشکال خود دنبال کنید.
- موارد تکراری را بررسی کنید
- جمع آوری شواهد
- مشکل را پیدا کنید
- تولید مثل خود را محکم کنید
- یک علت را پیشنهاد کنید
- مشکل خود را بنویسید!
جمع آوری شواهد
به طور کلی، هرچه اطلاعات باگ شما بیشتر باشد، بهتر است. در اینجا چند مورد وجود دارد که ممکن است بخواهید ارائه دهید:
- اگر یک باگ باعث ایجاد مشکل بصری شود، اسکرین شات ها یا گیف ها می توانند واقعا مفید باشند.
- کد نمونه در صورتی مفید است که یک باگ فقط بر انواع خاصی از بلوک‌ها یا پیکربندی‌های فضاهای کاری تأثیر بگذارد.
- اگر در بازتولید اشکال خود در خارج از محیط خاص خود مشکل دارید ، یک سایت میزبانی شده عالی است.
مشکل را پیدا کنید
بین کتابخانه هسته، پلاگین ها، نمونه ها و لبه های کد، کدهای Blockly زیادی داریم. با گفتن دقیق مشکل از کجا به ما کمک کنید.
اگر مشکل در هسته است، کدام جزء؟ به عنوان مثال، ممکن است مشکل از جعبه ابزار، یا کنترل های بزرگنمایی یا بلوک های کتابخانه باشد. تا حد ممکن دقیق باشید.
اگر مشکل در نمونه‌های بلوکی است، بفهمید که در کدام پلاگین، کد لبه یا نمونه است. اگر همان اشکال را در چندین مکان پیدا کردید، آن را به ما نیز بگویید.
تولید مثل خود را محکم کنید
یک باگ فقط در صورتی قابل رفع است که قابل تکرار باشد، بنابراین قبل از اینکه مشکلی را ارسال کنید، مطمئن شوید که یک راه محکم برای بروز اشکال خود دارید.
در نهایت باید فهرستی شماره‌دار از مراحل دریافت کنید که به توسعه‌دهنده می‌گوید چگونه اشکال را بازتولید کند. مثلا:
- کد X را باز کنید.
- به صفحه Y بروید.
- کد مثال Z را اجرا کنید.
- رفتار بد را که شبیه W است مشاهده کنید.
اگر مشکل شما در هسته Blockly است، سعی کنید آن را در زمین بازی بازتولید کنید.
یک علت را پیشنهاد کنید
اگر فکر می‌کنید می‌دانید چرا این اشکال رخ می‌دهد، آن اطلاعات را نیز درج کنید. باز هم، تا حد امکان خاص باشید.
مشکل خود را بنویسید!
زمان نوشتن گزارش اشکال فرا رسیده است. مخزن خود را انتخاب کنید:
مطمئن شوید که تمام بخش‌های قالب شماره را پر کنید، حتی آنهایی که در اینجا به تفصیل نیست.
از علاقه شما به گزارش یک اشکال و نوشتن مشکل خوشحالیم!
بعد چه می شود؟
- گزارش اشکال شما به طور خودکار برای تریاژ برچسب گذاری می شود.
- عضو حاضر در تیم Blockly نگاهی خواهد انداخت و احتمالاً سؤالات روشنگری می پرسد. آنها همچنین برچسب هایی را اضافه می کنند که ما از آنها برای سازماندهی کردن اشکالات خود استفاده می کنیم.
- ممکن است علامت "Help Wanted" باشد، در این صورت می توانید آن را ادعا کرده و شروع به کار کنید.
- ممکن است این مشکل برای رفع مشکل به یکی از اعضای تیم Blockly اختصاص داده شود.
- ممکن است این موضوع با نقطه عطف سه ماهه مشخص شود تا مشخص شود چه زمانی انجام می شود.
- این موضوع ممکن است در نقطه عطف Icebox قرار گیرد، به این معنی که ما قصد نداریم در آینده قابل پیش بینی روی آن کار کنیم.
- این ممکن است برای مشکلات فرکانس پایین یا اشکالات با راه‌حل‌های شناخته شده اتفاق بیفتد.
- هنوز هم می توانید روی مسائل مربوط به Iceboxed کار کنید.
- این مشکل ممکن است در نقطه عطف Bug Bash Backlog قرار گرفته باشد، به این معنی که غیر فوری است اما ما همچنان می خواهیم آن را برطرف کنیم.
- در پایان هر سه‌ماهه، تیم چند هفته‌ای را بر روی اشکالات استخراج شده از نقطه عطف Bug Bash Backlog کار می‌کند.
- در صورت نیاز ممکن است مشکل از هسته Blockly به نمونه های بلوکی (یا جهت مخالف) منتقل شود.
- ممکن است موضوع بسته شود.
درخواست ویژگی
آیا چیزی وجود دارد که بخواهید برای بهتر کردن Blockly تغییر دهید؟ آیا ایده ای برای یک پلاگین، مثال یا نرم افزار کد دارید؟ شاید در حال حاضر یکی وجود داشته باشد که شما دوست دارید، و شما راهی برای بهبود آن پیدا کرده اید. اگر چنین است پس به جای درست آمده اید! در اینجا مراحلی وجود دارد که به شما کمک می کند یک درخواست ویژگی عالی ایجاد کنید که پاسخ دریافت کند.
الزامات را بررسی کنید
ما دوست داریم به تک تک ایده ها اجازه ورود به این مخزن را بدهیم! اما متأسفانه ما فقط انسان هستیم، بنابراین دستورالعمل‌هایی در مورد نوع درخواست‌هایی داریم که دنبال خواهیم کرد.
در اینجا دستورالعمل های مربوط به هر یک از دسته های مختلف پروژه آورده شده است:
- هسته بلوکی
- پلاگین ها
- مثال‌ها: نحوه استفاده از تنها یک یا دو ویژگی Blockly را نشان دهید.
- Codelabs: نحوه تکمیل یک کار یا اجرای یک رفتار واحد را نشان می دهد.
اما اینها قوانین سخت و سریعی نیستند. آنها فقط قصد دارند قبل از اینکه برای ایجاد درخواست ویژگی خود وقت بگذارید، ایده ای از آنچه ما به دنبال آن هستیم به شما بدهند.
اگر مطمئن نیستید که چیزی مناسب است یا خیر، سعی کنید آن را در تالار گفتمان توسعه دهندگان ما پست کنید. و به یاد داشته باشید، حتی اگر ایده شما پذیرفته نشود، ما همچنان دوست داریم که آن را به عنوان یک افزونه یا آموزش شخص ثالث بسازید!
افکارت را جمع کن
نیازی نیست که ایده شما 100% با قلوه سنگ و نمودارها قبل از ادامه دادن و ارسال آن تطبیق داده شود، اما باید یک ایده محکم از آنچه به دنبال آن هستید داشته باشید. اینها چند سوال خوب هستند که باید قبل از شروع به نوشتن فکر کنید:
- چرا من این ویژگی را می خواهم؟
- آیا این ویژگی مشکلی را حل می کند؟
- مخاطب مورد نظر برای این ویژگی چه کسانی هستند؟
- چرا این ویژگی به آنها خدمت می کند؟
- چه گزینه های جایگزینی وجود دارد که می تواند به همان چیزی برسد؟
وقتی آن چیزها را فهمیدید، بیشتر راه را به یک درخواست ویژگی خوب خواهید رساند!
درخواست ویژگی خود را بنویسید!
اکنون آماده نوشتن درخواست ویژگی خود هستید. مخزن خود را انتخاب کنید:
مطمئن شوید که تمام بخش‌های قالب شماره را پر کنید، حتی آنهایی که در اینجا به تفصیل نیست.
از علاقه شما به ارسال یک درخواست ویژگی، و نوشتن مسئله مبارک!
بعد چه می شود؟
- درخواست ویژگی شما به طور خودکار برای تریاژ برچسب گذاری می شود.
- عضو حاضر در تیم Blockly نگاهی خواهد انداخت و احتمالاً سؤالات روشنگری می پرسد. آنها همچنین برچسب هایی را اضافه می کنند که ما از آنها برای سازماندهی کردن اشکالات خود استفاده می کنیم.
- این ویژگی ممکن است "Help Wanted" علامت گذاری شود، در این صورت می توانید آن را ادعا کرده و شروع به کار روی آن کنید.
- این ویژگی ممکن است برای اجرا به یکی از اعضای تیم Blockly اختصاص داده شود.
- درخواست ویژگی ممکن است در صورت نیاز از هسته Blockly به نمونه های بلوکی (یا جهت مخالف) منتقل شود.
- ممکن است درخواست ویژگی بسته شود، در این صورت شما همچنان می‌توانید آن را به عنوان یک افزونه شخص ثالث پیاده‌سازی کنید.