ابزارها و بسته‌ها
پیش از نصب
Section titled “پیش از نصب”از صفحه رسمی محصول شروع کنید. وضعیت انتشار، پلتفرم، محیط اجرا یا نسخه ویرایشگر و مجوز را بررسی کنید. وجود نام بسته در مثال، اثبات وجود آن در رجیستری نیست.
این راهنما بسته یا SDK عمومی بیات را معرفی نمی‌کند. دستور نصب مخصوص محصول، همراه با لینک رجیستری تأییدشده و نسخه منتشرشده ارائه خواهد شد.
نسخه بازتولیدپذیر انتخاب کنید
Section titled “نسخه بازتولیدپذیر انتخاب کنید”وقتی بسته‌ای ارائه شد، نسخه آزمایش‌شده را ثبت کنید و فایل قفل وابستگی‌ها را نگه دارید. پیش از ارتقا، یادداشت انتشار را بخوانید و تغییر را در پروژه‌ای قابل بازیابی امتحان کنید.
اطلاعات محرمانه را وارد مثال نکنید
Section titled “اطلاعات محرمانه را وارد مثال نکنید”از مقدار نمونه با برچسب روشن استفاده کنید. توکن واقعی باید در محل مناسب نگهداری رازها یا محیط سرور باشد، نه گزارش عمومی، تصویر، کد ثبت‌شده یا بسته سمت کاربر.
هنگام معرفی API
Section titled “هنگام معرفی API”مرجع باید آدرس پایه، روش احراز هویت، نسخه، شکل درخواست و پاسخ، خطا، محدودیت نرخ و چرخه عمر را مشخص کند. از روی نام دامنه، مسیر API را حدس نزنید.
کمک بگیرید
Section titled “کمک بگیرید”نام ابزار یا بسته، نسخه دقیق، محیط مرتبط، نتیجه مورد انتظار و نمونه کوچک بازتولید را ارائه کنید. گزارش مشکل را ببینید.