درخواست های کششی مانند خون حیات یک مخزن هستند. آنها همه چیز را سالم و متحرک نگه می دارند. این صفحه نحوه ایجاد یک روابط عمومی را توضیح می دهد که کامل و آسان برای بررسی باشد، که احتمال ادغام روابط عمومی شما را بیشتر می کند.
در اینجا مراحلی وجود دارد که می توانید برای اطمینان از ایجاد بهترین روابط عمومی ممکن انجام دهید.
- برقراری ارتباط
- راه اندازی کنید
- آن را کوچک نگه دارید
- تمیز نگهش دار
- تغییر خود را آزمایش کنید
- برقراری ارتباط (pt2)
برقراری ارتباط
قبل از اینکه وارد شوید و شروع به نوشتن کد کنید، برقراری ارتباط با تیم اصلی مفید است تا آنها بدانند به چه چیزی علاقه دارید.
اگر مشکلی وجود دارد که به آن علاقه دارید، در مورد آن موضوع نظر بدهید و بگویید که می خواهید روی آن کار کنید. این اطمینان حاصل می کند که ما چندین نفر روی یک چیز کار نمی کنند. یکی از اعضای تیم پاسخ خواهد داد تا تأیید کند که مال شماست.
اگر ایده ای دارید که با موضوعی پوشش داده نمی شود، لطفاً قبل از شروع کار ، آن را بنویسید . این به تیم فرصتی می‌دهد تا قبل از شروع ساخت، درباره بهترین روش ایجاد تغییر بحث کنند، که در درازمدت باعث صرفه‌جویی در کار شما می‌شود.
راه اندازی کنید
اگر این اولین بار است که در Blockly یا blockly-samples مشارکت می‌کنید، از صفحه راه‌اندازی توسعه شروع کنید.
آن را کوچک نگه دارید
همیشه سعی کنید تغییرات خود را کوچک و متمرکز نگه دارید. ما ترجیح می دهیم چندین PR کوچکتر را به جای بررسی یک PR غول پیکر بررسی کنیم. برخی از قوانین سرانگشتی خوب عبارتند از:
- یک مشکل را برطرف کنید. سعی نکنید به طور همزمان چندین مسئله را حل کنید.
- دامنه را محدود کنید. معمولاً یک PR باید کمتر از 8 ساعت طول بکشد (بسته به آشنایی شما با پایگاه کد).
- از commit ها استفاده کنید اگر روابط عمومی شما کمی بزرگ است، با استفاده از git commit، تغییرات را به گروه های منطقی تقسیم کنید.
تمیز نگهش دار
چرا به سبک کد اهمیت می دهیم؟ ما برای درازمدت درگیر آن هستیم و سبک ثابت نگهداری را آسان‌تر می‌کند. Style به نحوه نامگذاری متغیرهای خود اشاره دارد، اما نحوه ساختار کد، نوشتن نظرات و موارد دیگر را نیز پوشش می دهد. در صورت امکان از ابزارهایی مانند eslint برای خودکارسازی بررسی سبک استفاده می کنیم.
علاوه بر اسلینت، لطفاً این راهنماها را دنبال کنید:
- راهنمای سبک جاوا اسکریپت گوگل
- راهنمای پیام متعهد
- دستورالعمل های استفاده از API های Blockly
- راهنمای سبک کدلب
تغییر خود را آزمایش کنید
قبل از ارائه یک روابط عمومی، همیشه باید آزمایش کنید که تغییرات شما کار می کنند، به طوری که مجبور نباشید بعداً به عقب برگردید و موارد را اصلاح کنید. در اینجا چند ایده برای آزمایش دسته های مختلف پروژه ها وجود دارد:
- برای افزونه ها : تست های خودکار موکا را بنویسید که تغییرات شما را پوشش می دهد.
- برای مثال : به صورت دستی همه عملکردهای نشان داده شده خود را آزمایش کنید.
- برای Codelabs : کل آموزش را در یک محیط تمیز اجرا کنید و هر کد نمونه ای را که ارائه می کنید آزمایش کنید.
برقراری ارتباط
این آخرین و مسلماً مهمترین بخش ایجاد یک روابط عمومی است: نوشتن خلاصه.
نوشتن یک خلاصه روابط عمومی عالی به توسعه دهندگان دیگر کمک می کند تا تغییرات شما را بررسی کنند و احتمال اینکه سریعتر پذیرفته شود بیشتر می شود!
خلاصه شما باید شامل موارد زیر باشد:
- روابط عمومی شما به چه موضوعی مربوط می شود.
- روابط عمومی شما چه تغییری ایجاد می کند.
- چگونه تغییر خود را آزمایش کردید
- هر چیزی را که می خواهید بازبینان بررسی کنند.
- هر گونه اطلاعات دیگری که فکر می کنید بازبین ها به آن نیاز دارند.
اگر هنگام ایجاد درخواست خود از الگوی روابط عمومی پیروی کنید، باید آن را ادامه دهید. فقط به یاد داشته باشید که تا حد امکان مختصر و کامل باشید.
کد نویسی مبارک!