نحوه ثبت کردن اشکال مرورگر خوب

اطلاع دادن به فروشندگان مرورگر درباره مشکلاتی که در مرورگرشان پیدا می‌کنید بخش جدایی‌ناپذیری از بهبود پلاتفرم وب است.

ثبت اشکال خوب اما کمی کار می‌برد. هدف شما باید این باشد که تا حد امکان برای مهندسان مرورگر آسان کنید تا آنچه را خراب است پیدا کنند، به علت ریشه‌ای برسند و، مهم‌تر از همه، راهی برای رفع آن پیدا کنند. اشکالاتی که سریع پیشرفت می‌کنند معمولاً به‌سرعت بازتولید می‌شوند و رفتار موردانتظار واضحی دارند.

تأیید کنید که اشکال است

اولین قدم این است که بفهمیم رفتار «صحیح» چه باید باشد.

رفتار درست چیست؟

اسناد میانای برنامه‌سازی کاربردی مربوطه را در MDN بررسی کنید یا سعی کنید مشخصات مرتبط را پیدا کنید. این اطلاعات می‌تواند به شما کمک کند تصمیم بگیرید کدام API واقعاً خراب است، کجا خراب است، و رفتار موردانتظار چیست.

آیا در مرورگر دیگری کار می‌کند؟

رفتاری که بین مرورگرها متفاوت است معمولاً به‌عنوان مشکل هم‌کنش‌پذیری اولویت بالاتری دارد، به‌ویژه زمانی که مرورگر حاوی اشکال با بقیه متفاوت باشد. سعی کنید در جدیدترین نسخه‌های Chrome،‏ Firefox،‏ Safari، و Edge آزمایش کنید، احتمالاً بااستفاده از ابزاری مثل BrowserStack.

درصورت امکان، بررسی کنید که صفحه به‌دلیل بوکشیدن نماینده کاربر، عمداً رفتار متفاوتی نداشته باشد. در Chrome DevTools، رشته User-Agent را روی مرورگر دیگری تنظیم کنید.

آیا در نسخه پخش اخیر خراب شده است؟

آیا این ویژگی در گذشته طبق انتظار کار می‌کرد، اما در نسخه اخیر مرورگر خراب شده است؟ چنین پسرفت‌هایی را می‌توان خیلی سریع‌تر برطرف کرد، به‌ویژه اگر شماره نسخه‌ای را که در آن کار می‌کرده و نسخه‌ای را که در آن کار نمی‌کند ارائه دهید. می‌توانید از ابزارهایی مثل BrowserStack برای بررسی نسخه‌های قدیمی مرورگر استفاده کنید. از ابزارهایی مانند ابزار bisect-builds (برای Chromium) برای جستجوی تغییر استفاده کنید.

اگر مشکل از نوع رگرسیون باشد و بتوان آن را بازتولید کرد، معمولاً علت ریشه‌ای را می‌توان به‌سرعت پیدا و برطرف کرد.

آیا دیگران هم همین مشکل را می‌بینند؟

اگر با مشکلی مواجه هستید، احتمالاً توسعه‌دهندگان دیگر هم با آن مواجه هستند. ابتدا، سعی کنید اشکال را در Stack Overflow جستجو کنید. این کار ممکن است به شما کمک کند تا یک مشکل انتزاعی را به یک API خراب خاص ترجمه کنید، و ممکن است به شما کمک کند تا یک راه حل موقت پیدا کنید تا زمانی که اشکال برطرف شود.

آیا قبلاً گزارش شده است؟

وقتی متوجه شدید اشکال چیست، وقت آن است که با جستجو در پایگاه داده اشکال مرورگر بررسی کنید که آیا این اشکال قبلاً گزارش شده است یا نه.

اگر اشکال موجودی را پیدا کردید که مشکل را شرح می‌دهد، با ستاره‌دار کردن، افزودن به موارد دلخواه، یا نظر دادن درباره اشکال، حمایتتان را اضافه کنید. و در بسیاری از سایت‌ها، می‌توانید خودتان را به فهرست رونوشت اضافه کنید و وقتی اشکال تغییر کرد، به‌روزرسانی دریافت کنید.

اگر تصمیم گرفتید درباره اشکال نظر دهید، اطلاعاتی درباره نحوه تأثیر اشکال بر وب‌سایتتان اضافه کنید. از افزودن نظراتی به سبک «+1» خودداری کنید، زیرا ردیاب‌های اشکال معمولاً برای هر نظر ایمیل ارسال می‌کنند.

گزارش کردن اشکال

اگر این اشکال قبلاً گزارش نشده است، وقت آن است که به فروشنده مرورگر اطلاع دهید.

ایجاد چارچوب تست کوچک‌شده

Mozilla مقاله بسیار خوبی درباره نحوه ایجاد چارچوب تست کوچک‌شده دارد. خلاصه اینکه، اگرچه شرح مشکل شروع خوبی است، اما هیچ‌چیز بهتر از ارائه نسخه نمایشی پیوندشده در اشکال نیست که مشکل را نشان دهد. برای بیشینه‌سازی احتمال پیشرفت سریع، نمونه باید حاوی حداقل کد ممکن برای نشان دادن مشکل باشد. نمونه کد حداقلی مهم‌ترین کاری است که می‌توانید برای افزایش احتمال رفع اشکال انجام دهید.

در اینجا چند نکته برای به‌حداقل رساندن چارچوب تست آورده شده است:

  • صفحه وب را بارگیری کنید، <base href="https://original.url"> را اضافه کنید و بررسی کنید که اشکال به‌صورت محلی وجود دارد. اگر نشانی وب از HTTPS استفاده می‌کند، ممکن است به سرور HTTPS فعال نیاز داشته باشد.
  • فایل‌های محلی را در جدیدترین نسخه‌های ساخت هر تعداد مرورگری که می‌توانید آزمایش کنید.
  • سعی کنید همه چیز را در ۱ فایل فشرده کنید.
  • کد را بردارید (با چیزهایی شروع کنید که می‌دانید غیرضروری هستند) تا زمانی که اشکال برطرف شود.
  • از کنترل نسخه استفاده کنید تا بتوانید کارتان را ذخیره کنید و کارهایی را که اشتباه انجام شده‌اند واگرد کنید.

میزبانی چارچوب تست کوچک‌شده

اگر به‌دنبال جای خوبی برای میزبانی چارچوب تست کوچک‌شده‌تان هستید، چند جای خوب دردسترس است:

توجه داشته باشید که چندین مورد از این سایت‌ها محتوا را در iframe نمایش می‌دهند که ممکن است باعث شود ویژگی‌ها یا اشکال‌ها رفتار متفاوتی داشته باشند.

ارسال مشکل

وقتی چارچوب تست کوچک‌شده را دریافت کردید، آماده‌اید آن اشکال را ثبت کنید. به سایت ردیابی اشکال مناسب بروید و مشکل جدیدی ایجاد کنید.

شرح واضح و مراحل تکرار را اضافه کنید

ابتدا شرح واضحی ارائه دهید تا به مهندسان کمک کند سریعاً متوجه شوند مشکل چیست و به اولویت‌بندی مشکل کمک کند.

When installing a PWA using the `beforeinstallprompt.prompt()`, the
`appinstalled` event fires before the call to `prompt()` resolves.

سپس، مراحل دقیق لازم برای بازتولید مشکل را ارائه دهید و نتیجه موردانتظار و واقعی را شرح دهید.

What is the expected result? In the console:
0. INSTALL: Available (logged when `beforeinstallprompt` event fired)
1. INSTALL_PROMPT_RESPONSE: {outcome: "accepted", platform: "web"}
   (logged when beforeinstallprompt.prompt()` resolves)
2. INSTALL: Success (logged when `appinstalled` event fired)

What is the actual result? In the console:
0. INSTALL: Available (logged when `beforeinstallprompt` event fired)
1. INSTALL: Success (logged when `appinstalled` event fired)
2. INSTALL_PROMPT_RESPONSE: {outcome: "accepted", platform: "web"}
   (logged when beforeinstallprompt.prompt()` resolves)

برای اطلاعات بیشتر، رهنمودهای نوشتن گزارش اشکال را در MDN بررسی کنید.

پاداش: نماگرفت یا ضبط ویدیویی از صفحه مشکل را اضافه کنید

هرچند الزامی نیست، اما اغلب افزودن نماگرفت یا ضبط ویدیویی از صفحه مشکل مفید است. این کار به‌ویژه زمانی مفید است که اشکال‌ها پس‌از چند مرحله یا فعالیت غیرمعمول رخ می‌دهند. ضبط ویدیویی از صفحه و نماگرفت‌ها اغلب می‌توانند آنچه را اتفاق افتاده است بهتر به مهندسان مرورگر نشان دهند.

جزئیات محیط را اضافه کنید

برخی‌از اشکال‌ها فقط در سیستم‌عامل‌های خاصی یا فقط در انواع خاصی از نمایشگرها (برای مثال، DPI پایین یا DPI بالا) قابل‌تولید مجدد هستند. حتماً جزئیات محیط‌های آزمایشی را که استفاده کرده‌اید اضافه کنید.

ارسال اشکال

درنهایت، اشکال را ارسال کنید. منتظر دریافت پاسخ‌های مربوط به اشکال در ایمیلتان باشید. معمولاً درطول بررسی، مهندسان ممکن است سؤالات بیشتری داشته باشند. اگر در بازتولید مشکل با دشواری مواجه شوند، ممکن است با شما تماس بگیرند.