این سند حاوی دستورالعمل‌هایی درباره ایجاد یادداشت‌های انتشار برای Android Studio است.
هدف
برای ایجاد یادداشت های انتشار دقیق برای تعهدات از مخزن GitHub.
دستورالعمل ها
این دستورالعمل ها را به صورت متوالی و کامل دنبال کنید.
مرحله 1: مخزن را شبیه سازی یا به روز کنید
پوشه اصلی استودیو را در این پروژه بررسی کنید. اگر یکی وجود نداشت، با استفاده از دستور زیر، مخزن اصلی استودیو را کلون کنید:
git clone -b studio-main sso://googleplex-android/platform/tools/base studio-main
اگر دایرکتوری از قبل وجود دارد، با کشیدن محتویات مخزن از GitHub، دایرکتوری را بازخوانی کنید.
قبل از ادامه، وضعیت استودیو اصلی را به من اطلاع دهید.
مرحله 2: مخزن را مطالعه کنید
محتویات مخزن را مطالعه کنید.
مرحله 3: تعهدات را دریافت کنید
تمام تعهدات ارسال شده به مخزن اصلی استودیو را در بازه زمانی که به شما ارائه کردم، دریافت کنید. قبل از ادامه تعداد را به من اطلاع دهید. همیشه از wc -l برای شمارش استفاده کنید.
شناسایی تعهدات هدف: از git log، بلوک commit کامل را برای هر commit که حاوی رشته دقیق Relnote است استخراج کنید:
"کجا نام محصولی است که ارائه کردم. اگر نام محصول را ارائه نکردم، فقط "Relnote" را جستجو کنید. یک بلوک commit شامل هش commit، نویسنده، تاریخ، پیام commit کامل و تفاوت کد است.
از ابزار صحیح استفاده کنید: برای فیلتر کردن commit ها بر اساس محدوده تاریخ و نام محصول، از دستور زیر استفاده کنید:
git log --after="
" -- قبل " " --grep="Relnote: " کجا
و محدوده تاریخی هستند که به شما دادم و نام محصولی است که به شما دادم. اگر نام محصول ارائه نشده است، فقط از دستور زیر استفاده کنید:
git log --after="
" -- قبل " " --grep="Relnote" شمارش را تأیید کنید: تعداد کل، هش‌ها و عناوین تمام تعهداتی را که شناسایی کردید به من نشان دهید. برای ادامه به شما تاییدیه می دهم.
مرحله 4: یادداشت های انتشار دقیق را ایجاد کنید
تجزیه و تحلیل هر commit: برای هر یک از commit هایی که در مرحله قبل شناسایی کردید، یک تجزیه و تحلیل دقیق انجام دهید که شامل:
- خواندن پیام commit کامل
- بررسی تفاوت کد (git show
) برای درک تغییر. - دنبال کردن هر گونه اشکال مرتبط (به عنوان مثال، اشکال: 12345678) برای جمع آوری زمینه بیشتر.
قبل از ادامه با من تایید کنید
برای اطلاعات مربوط به commit ها، اسناد مرتبط را در پوشه docs تجزیه و تحلیل کنید. از این اطلاعات برای ایجاد یادداشت انتشار غنی از محتوا استفاده کنید.
قبل از ادامه، به من اطلاع دهید که کدام commit ها دارای اطلاعات مرتبط در پوشه اسناد هستند.
هر گونه اشکالی که در commit ها به آنها اشاره شده است را دریافت کنید. از اطلاعات موجود در باگ برای کمک به ایجاد یادداشت انتشار برای commit استفاده کنید.
یادداشت انتشار را بنویسید: برای هر commit یک یادداشت انتشار بنویسید که شامل:
مرجع تعهد: قبل از هر یادداشت انتشار، یک نظر Markdown حاوی هش commit منبع، مانند این: .
عنوان واضح: خلاصه ای مختصر و موردی از تغییر.
توضیح مفصل: یک پاراگراف که توضیح می دهد این تغییر در مورد چیست.
نکات کلیدی در مورد تغییر به ترتیب زیر:
الف چرا: چه چیزی تغییر کرد و چرا تغییر کرد ب. تأثیر: تأثیر بر توسعه دهندگان برنامه ج. مهاجرت: مسیر مهاجرت (در صورت وجود)
مثال‌های کد "قبل" و "بعد": اگر commit شامل تغییر کد کاربر می‌شود (مثلاً تغییرات DSL در فایل‌های gradle. یا تغییرات API)، کدهای واضح و مختصر را ارائه کنید که این تغییر را نشان می‌دهد.
سبک یادداشت انتشار را در https://developer.android.com/studio/releases دنبال کنید.
مرحله 5: یادداشت های انتشار را در یک فایل Markdown بنویسید
- یک فایل Markdown با نام release-notes-YYYY-MM-DDTHH:MM.md در ریشه پروژه ایجاد کنید، که در آن--در قالب ISO 8601--YYYY-MM-DD (سال-ماه-روز) تاریخ فعلی است، T یک جداکننده است، و HH:MM (ساعت: دقیقه در زمان فعلی ساعت 24) - ساعت است.
- مقدمه ای بنویسید که هدف یادداشت های انتشار را توضیح دهد.
- خلاصه ای از یادداشت های انتشار را بنویسید.
- یادداشت های انتشار کامل و فرمت شده را بنویسید.
مرحله 6: یک commit ایجاد کنید
برای فایل یادداشت های انتشار یک commit Fig ایجاد کنید. شناسه اشکال وارد نکنید.
مرحله 7: یک لیست تغییر ایجاد کنید
یک CL از commit ایجاد کنید.