Question

چگونه مشکلات بسته‌های bidi و xepersian را گزارش کنیم؟

(هدف از این پرسش و پاسخ نوشتن راهنمایی کامل برای گزارش مشکلات بسته‌های bidi و xepersian است)

Answer 1

قسمت اول

چنانچه مشکلی با بسته‌های bidi و xepersian وجود داره می‌تونید از GitHub برای گزارش مشکلات استفاده کنید. من متأسفانه نمی‌تونم همه پرسش‌ها رو در اینجا و جاهای دیگر نگاه کنم بنابراین اگر مشکلی وجود داره یا اینکه می‌خواهید من به پرسشتون نگاه کنم، حتماً از روشی که در ادامه می‌آید برای گزارش مشکل یا حتی پرسش در GitHub استفاده کنید. حتی اگر پرسشی هم در مورد مشکلات بسته‌ها اینجا وجود داشته باشه من اون رو به GitHub منتقل می‌کنم بنابراین برای گرفتن پاسخ سریعتر بهتره شما هم برای گزارش مشکلات و پرسش‌هایی که توجه من رو می‌خواهد از GitHub استفاده کنید.

برچسب‌ها

حدود ۱۶ برچسب برای گزارش مشکل برای هر دو بسته bidi و xepersian وجود داره. این برچسب‌ها خیلی مهم هستند چون من وقتی مشکلات رو نگاه می‌کنم برچسب‌ها رو filter می‌کنم و مشکلاتی که مهمتر هستند اول حل خواهند شد و اگر برچسب مناسبی رو برای گزارش مشکل یا پرسشتون انتخاب نکرده باشید، ممکنه که مشکل شما یا پرسش شما خیلی دیرتر از اونچه که باید حل بشه، پاسخ داده بشه. برچسب‌ها بصورت زیر هستند:

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

• Critical مخصوص مشکلات/پرسش‌هایی است که خیلی مهم هستند.
• Major مخصوص مشکلات/پرسش‌هایی است که مهم هستند اما از نظر اهمیت از درجه پائینتری از Critical قرار دارند.
• Normal مخصوص مشکلات/پرسش‌های عادی است که از نظر اهمیت از درجه پائینتری از Major قرار دارند.
• Minor مخصوص مشکلات/پرسش‌هایی هستند که اهمیت چندانی ندارند و در حروف‌چینی مشکل زیادی ایجاد نمی‌کنند.

شرح بقیه برچسب‌ها بصورت زیر است:

• ‌Bug مشخص کننده مشکل در بسته‌های bidi و xepersian است.
• Compatibility مشخص کننده ناسازگاری/سازگاری بسته‌های bidi و xepersian با سایر بسته‌ها/کلاس‌ها یا قالب‌های لاتین هست که شما قصد تبدیل آنها رو به زبان پارسی دارید.
• Documentation مربوط به راهنمای بسته‌های bidi و xepersian است. بنابراین اگر در راهنما خطایی وجود داره از این برچسب برای گزارشش می‌تونید استفاده کنید.
• Duplicate مخصوص مشکل‌ها/پرسش‌هایی است که قبلاً یک بار پرسیده شدند و دوباره پرسیده می‌شوند. معمولاً کاربر از این برچسب استفاده نمی‌کنه چون خودش بی‌خبره از اینکه گزارش مشکلش تکراری. این برچسب بیشتر توسط من استفاده میشه.

• Engine مخصوص مشکلات مربوط به موتور زی‌تک هستند. به عنوان نمونه مشکل رنگ متن‌هایی که در چند خط قرار می‌گیرند مشکل موتور زی‌تک است. نمونه دیگر، لینک‌هایی است که در دو خط قرار می‌گیره. نمونه دیگر مشکل \special است.

• Enhancement مخصوص پرسش‌ها/مشکلاتی است که منجر به بهبود در عمکرد بسته‌های bidi یا xepersian می‌شود.

• Feature مخصوص مشکلات/پرسش‌هایی است که خواستار ویژگی جدید یا سازگاری با بسته‌های دیگر در بسته‌های bidi و xepersian است.

• Font مخصوص مشکلات/پرسش‌هایی است که با قلم ارتباط دارند.

• Invalid توسط کاربر استفاده نمیشه و بیشتر توسط من استفاده میشه و به این معنی که گزارش مشکل/پرسش بی‌معناست چون ممکنه کاربر از نسخه قدیمی بسته‌های bidi و xepersian استفاده می‌کنه و مشکل با نسخه حال وجود نداره.

• Question مبروط به پرسش است یا گزارش مشکلاتی که مطمئن نیستید مشکل هستند.

• Update مربوط به مشکلاتی هستند که کدهای بسته‌های bidi و xepersian قدیمی هستند به عنوان مثال بسته bidi برای تغییر در بسته x ازکدهای قدیمی استفاده می‌کنه و حالا بسته x بروز شده و دیگر بسته bidi با بسته x کار نمی‌کنه یا نتیجه مطلوب حاصل نمیشه.

• Wontfix مخصوص کاربر نیست و بیشتر توسط من استفاده میشه و مخصوص مشکلاتی است که حلشون ممکن نیست چون مشکل از جای دیگری است. به عنوان نمونه، اگر مشکل از متور زی‌تک باشد و حل مشکل توسط ماکرونویسی غیرممکن باشد از این برچسب استفاده می‌شود.

Answer 2

قسمت دوم

راهنمای چگونگی گزارش مشکل/پرسش

نخست باید تصمیم بگیرید مشکل/پرسشی که قصد گزارش آن را دارید مربوط به بسته bidi است یا xepersian؟ مشکل‌ها/پرسش‌هایی که مربوط به جهت نوشته (راست به چپ بودن یا چپ به راست بودن) است، مشکلات/پرسش‌های بسته bidi است. مشکلاتی که در ارتباط با قلم، ویژگی‌های زبان پارسی (شمارنده‌های حرفی، عددی، ترتیبی و ..) است، مشکل بسته xepersian است.

برای گزارش مشکلات/پرسش‌های بسته bidi از این لینک و برای گزارش مشکلات/پرسش‌های بسته xepersian از این لینک استفاده کنید.

بعد از کلیک بر روی لینک مربوطه صفحه‌ای که می‌بینید باید مشابه صفحه زیر باشد:

برای گزارش مشکل روی دکمه سبز (با نوشته رنگ سپید) New issue کلیک کنید. حالا صفحه‌ای مشابه زیر خواهید دید:

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

هنگامی که تصمیم گرفتید از چه برچسب‌هایی می‌خواهید استفاده کنید در سمت راست روی Labels کلیک کنید و برچسب‌های دلخواه خود را انتخاب کنید:

برای انتخاب هر یک از برچسب‌ها کافی است روی آن کلیک کنید.

برای گزارش مشکل از زبان انگلیسی استفاده کنید. ابتدا در قسمت Title عنوانی برای گزارش مشکل/پرسش خود انتخاب کنید. تا جای ممکن سعی کنید عنوان کوتاه باشد و خلاصه گزارش مشکل/پرسش شما باشد.

سپس در قسمت اصلی مشکل/پرسش خود را مطرح کنید. اگر می‌خواهید دستور را در بین خط قرار دهید بصورت زیر عمل کنید:

`\LTRfootnote`

این کار باعث می‌شود تا دستور یا هر چیز دیگری داخل یک کادر خاکستری‌رنگ قرار بگیرد مانند \LTRfootnote. برای قرار دادن چندین خط کد بصورت زیر عمل کنید:

````latex
\your \TeX code
\or
\your
\LaTeX
\Code
````

با استفاده از این کار کد چندخطی شما با syntax لاتک رنگی می‌شود. برای پیوست کردن فایل و مسايل دیگر می‌توانید از امکانات خود ویرایشگر استفاده کنید. این ویرایشگر از markdown استفاده می‌کنید. برای دیدن شکل ظاهری چیزی که نوشته‌اید (قبل از ارسال مشکل)، می‌توانید روی دکمه Preview در پائین قسمت Title استفاده کنید.

هنگامی که گزارش مشکل/پرسش خود را تکمیل کردید روی دکمه سبزرنگ (نوشته با رنگ سپید) Submit new issue کلیک کنید تا گزارش مشکل/پرسش شما ارسال شود.

Comments

با سپاس از زحمات بیکران


امکان برچسب‌گذاری غیر فعال شده است؟!

---

خیر، غیرفعال نشده است.