Update issue template and CONTRIBUTING.md

Author: sepehr-rs

.github/ISSUE_TEMPLATE/suggestion.md

@@ -1,34 +1,56 @@
 ---
 name: پیشنهاد تغییرات در ترجمه
-about: پیشنهاد تغییر در ترجمه‌ی یک واژه یا یک شیوه‌ی نگارشی ثابت‌شده
-title: ""
+about: پیشنهاد تغییر در ترجمه‌ی یک واژه، یک شیوه‌ی نگارشی، یا افزودن واژه‌ای به واژه‌نامه
+title: "[پیشنهاد] "
 labels: suggestion
 assignees: ''
 ---
 
-## واژه یا شیوه‌ی نگارش فعلی
+**## نوع پیشنهاد**
 
-<!-- واژه، اصطلاح یا قاعده‌ی نگارشیِ فعلی که می‌خواهید تغییر کند (در صورت وجود، ارجاع به GLOSSARY.md یا نمونه‌ای از STYLEGUIDE) -->
+<!-- یکی از گزینه‌های زیر را انتخاب کنید:
+- تغییر ترجمه‌ی یک واژه یا اصطلاح موجود
+- تغییر یک قاعده یا شیوه‌ی نگارشی
+- افزودن یک واژه یا اصطلاح جدید به واژه‌نامه
+-->
 
-## تغییر پیشنهادی
+- [ ] تغییر ترجمه‌ی یک واژه یا اصطلاح موجود
+- [ ] تغییر شیوه‌ی نگارش
+- [ ] افزودن واژه یا اصطلاح جدید به واژه‌نامه
 
-<!-- ترجمه یا شیوه‌ی نگارشی جدیدی که پیشنهاد می‌کنید -->
+**## مورد پیشنهادی**
 
-## دلیل پیشنهاد
+<!-- 
+- برای تغییر ترجمه: واژه یا اصطلاح فعلی را همراه با ترجمه‌ی فعلی بنویسید.
+- برای تغییر شیوه‌ی نگارش: قاعده یا الگوی فعلی را توضیح دهید.
+- برای افزودن به واژه‌نامه: واژه‌ی انگلیسی و ترجمه‌ی پیشنهادی را بنویسید.
+-->
 
-<!-- چرا ترجمه یا شیوه‌ی فعلی را مناسب نمی‌دانید و چرا پیشنهاد جدید بهتر است -->
+**## تغییر پیشنهادی**
 
-## نمونه‌ها / منابع
+<!-- ترجمه‌ی جدید، شیوه‌ی نگارشی پیشنهادی، یا مدخل پیشنهادی برای واژه‌نامه را بنویسید. -->
 
-<!-- در صورت وجود، لینک مستندات مرجع، نمونه‌ی استفاده در متن‌های دیگر، یا مثال‌هایی که از تغییر پشتیبانی می‌کنند -->
+**## دلیل پیشنهاد**
 
-## فرایند بررسی
+<!-- توضیح دهید چرا وضعیت فعلی مناسب نیست و چرا پیشنهاد جدید می‌تواند بهتر باشد. در صورت امکان، به یکدستی، دقت معنایی، خوانایی، یا سازگاری با واژه‌نامه اشاره کنید. -->
+
+**## نمونه‌ها / منابع**
+
+<!-- 
+در صورت وجود:
+- لینک مستندات مرجع
+- نمونه‌ی استفاده در بخش‌های دیگر ترجمه
+- نمونه از ترجمه‌های معتبر دیگر
+- مثال‌هایی که از پیشنهاد پشتیبانی می‌کنند
+-->
+
+**## فرایند بررسی**
 
 <!-- این بخش را خالی نگذارید و پیش از ارسال ایشیو مطالعه کنید -->
 
-- [ ] می‌دانم که پس از تأیید اولیه‌ی نگهدارندگان، نظرسنجی هم‌زمانی در گروه تلگرام و در همین ایشیو (با گزینه‌های پسندیدن/نپسندیدن) به مدت **دو هفته** برگزار می‌شود و نتیجه بر اساس مجموع آرا مشخص خواهد شد.
+- [ ] می‌دانم که پس از تأیید اولیه‌ی نگه‌دارندگان، نظرسنجی هم‌زمانی در گروه تلگرام و در همین ایشیو (با گزینه‌های پسندیدن/نپسندیدن) به مدت **دو هفته** برگزار می‌شود و نتیجه بر اساس مجموع آرا مشخص خواهد شد.
 - [ ] می‌دانم در صورت رأی نیاوردن، می‌توانم پس از **چهار هفته** دوباره همین پیشنهاد را به رأی بگذارم.
 
-## آیین‌نامه رفتاری
+**## آیین‌نامه رفتاری**
 
 - [ ] می‌پذیرم که از [آیین‌نامه‌ی رفتاری PSF](https://www.python.org/psf/conduct/) پیروی کنم.

CONTRIBUTING.md

@@ -52,11 +52,13 @@
 
 3. متن `msgid` را ترجمه کنید و در `msgstr` وارد کنید.
 
-4. **نشانه‌گذاری‌های Sphinx** مثل `` :class:`int` ``، `` :func:`repr` ``، `` :ref:`...` ``، `` ``code`` `` و **جای‌گذارها** مثل `%s` یا `{name}` را دقیقاً بدون تغییر نگه دارید؛ فقط متن اطراف آن‌ها ترجمه می‌شود. در `` :term:`target` ``، اگر عبارت داخل بک‌تیک با شناسه‌ی واژه‌نامه یکی است، می‌توانید آن را به شکل `` :term:`ترجمه <target>` `` بنویسید تا هم متن ترجمه‌شده نمایش داده شود و هم لینک درست کار کند؛ در این حالت فقط بخش نمایشی (پیش از `<`) ترجمه می‌شود و `target` داخل `<>` باید دقیقاً همان شناسه‌ی انگلیسی اصلی (بدون تغییر) باقی بماند، چون تغییر آن لینک را خراب می‌کند.
+4. برای پیدا کردن ترجمه‌ی مناسب برای کلمات و عبارات تخصصی، از [این](https://sepehr-rs.github.io/python-docs-fa-glossary/) پیوند به واژه‌یاب پایتون رفته و واژه/عبارت موردنظر خود را جست‌جو کنید.
 
-5. داخل کدها (بلوک‌های `code-block`) نام متغیرها، توابع، کلمات کلیدی و **کامنت‌ها** ترجمه نمی‌شوند؛ چون کد از راست به چپ نوشته نمی‌شود و وجود متن فارسی داخل آن، کد را ناخوانا می‌کند. فقط رشته‌های متنی (string) قابل‌ترجمه‌اند.
+5. **نشانه‌گذاری‌های Sphinx** مثل `` :class:`int` ``، `` :func:`repr` ``، `` :ref:`...` ``، `` ``code`` `` و **جای‌گذارها** مثل `%s` یا `{name}` را دقیقاً بدون تغییر نگه دارید؛ فقط متن اطراف آن‌ها ترجمه می‌شود. در `` :term:`target` ``، اگر عبارت داخل بک‌تیک با شناسه‌ی واژه‌نامه یکی است، می‌توانید آن را به شکل `` :term:`ترجمه <target>` `` بنویسید تا هم متن ترجمه‌شده نمایش داده شود و هم لینک درست کار کند؛ در این حالت فقط بخش نمایشی (پیش از `<`) ترجمه می‌شود و `target` داخل `<>` باید دقیقاً همان شناسه‌ی انگلیسی اصلی (بدون تغییر) باقی بماند، چون تغییر آن لینک را خراب می‌کند.
 
-6. اگر به اصطلاحی برخوردید که در واژه‌نامه نبود، ترجمه‌ای برای آن انتخاب کنید و به واژه‌نامه اضافه کنید.
+6. داخل کدها (بلوک‌های `code-block`) نام متغیرها، توابع، کلمات کلیدی و **کامنت‌ها** ترجمه نمی‌شوند؛ چون کد از راست به چپ نوشته نمی‌شود و وجود متن فارسی داخل آن، کد را ناخوانا می‌کند. فقط رشته‌های متنی (string) قابل‌ترجمه‌اند.
+
+7. اگر به اصطلاحی برخوردید که در واژه‌نامه نبود و فکر میکنید که باید در واژه‌نامه باشد، به بخش «افزودن واژه یا اصطلاح جدید به واژه‌نامه» همین پرونده بروید.
 
 ### بررسی‌ها قبل از ارسال پول‌ریکوئست
 
@@ -174,10 +176,19 @@ python3 scripts/update_python_version.py v3.15.0 --keep-src
 
 ## پیشنهاد تغییر در واژه یا شیوه‌ی نگارش
 
-اگر می‌خواهید تغییری در ترجمه‌ی یک واژه‌ی ثابت‌شده یا در یکی از شیوه‌های نگارشی رایج پروژه پیشنهاد دهید، این فرایند را دنبال کنید:
+اگر می‌خواهید تغییری در ترجمه‌ی یک واژه‌ی موجود در واژه‌نامه یا در یکی از شیوه‌های نگارشی رایج پروژه پیشنهاد دهید، این فرایند را دنبال کنید:
 
 1. یک ایشیو با قالب **«پیشنهاد تغییرات در ترجمه»** باز کنید.
-2. پس از تأیید اولیه‌ی نگهدارندگان پروژه، یک نظرسنجی هم‌زمان در گروه تلگرام و در همان ایشیوی گیت‌هاب (با گزینه‌های پسندیدن/نپسندیدن) آغاز می‌شود.
-3. این نظرسنجی به مدت **دو هفته** باز می‌ماند. در پایان این بازه، مجموع آرای موافق و مخالف تعیین می‌کند که آیا تغییر در مستندات اعمال شود یا نه.
-4. اگر تغییر رأی نیاورد، پیشنهاد همان تغییر را می‌توان پس از گذشت **چهار هفته** دوباره به رأی گذاشت.
-5. اگر تغییر رأی بیاورد، به یک ایشیوی اصلی (master issue) که فهرست کارها و تغییرات قابل‌انجام را ردیابی می‌کند اضافه می‌شود، تا هر مشارکت‌کننده‌ای که بخواهد بتواند آن را انجام دهد.
+2. پس از بررسی و تأیید اولیه‌ی نگهدارندگان پروژه، یک نظرسنجی هم‌زمان در گروه تلگرام و در همان ایشیوی گیت‌هاب (با گزینه‌های پسندیدن/نپسندیدن) آغاز می‌شود.
+3. این نظرسنجی به مدت **دو هفته** باز می‌ماند. در پایان این بازه، مجموع آرای موافق و مخالف به‌عنوان مبنای تصمیم‌گیری درباره‌ی اعمال یا رد تغییر در مستندات در نظر گرفته می‌شود.
+4. اگر پیشنهاد تغییر رأی موافق کسب نکند، همان پیشنهاد را می‌توان پس از گذشت **چهار هفته** دوباره به رأی گذاشت.
+5. اگر پیشنهاد تغییر رأی موافق کسب کند، به یک ایشیوی اصلی (master issue) که فهرست کارها و تغییرات قابل‌انجام را پیگیری می‌کند اضافه خواهد شد تا هر مشارکت‌کننده‌ای که مایل باشد بتواند اجرای آن را بر عهده بگیرد.
+
+## افزودن واژه یا اصطلاح جدید به واژه‌نامه
+
+اگر واژه یا اصطلاحی در واژه‌نامه‌ی پروژه وجود ندارد و می‌خواهید معادل پیشنهادی برای آن اضافه شود، یک ایشیو با قالب **«پیشنهاد تغییرات در ترجمه»** باز کنید و واژه‌ی انگلیسی، معادل پیشنهادی، و دلیل انتخاب آن را توضیح دهید.
+
+پیشنهادهای افزودن واژه‌ی جدید نیز پس از بررسی اولیه‌ی نگهدارندگان، در صورت نیاز از همان فرایند نظرسنجی توضیح داده شده در بالا استفاده خواهند کرد تا درباره‌ی پذیرش یا رد آن تصمیم‌گیری شود.
+
+## گزارش اشکال در واژه‌یاب
+لطفا برای گزارش اشکال در واژه‌یاب به مخزن [python-docs-fa-glossary](https://github.com/sepehr-rs/python-docs-fa-glossary) مراجعه کنید.