Skip to content

Commit 665a5ab

Browse files
sepehr-rssepehr-rs
authored
Update README.md (#49)
1 parent c8c9481 commit 665a5ab

1 file changed

Lines changed: 24 additions & 19 deletions

File tree

‎README.md‎

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,47 @@
1-
# ترجمه مستندات پایتون به فارسی 🐍💛
1+
# ترجمهٔ مستندات پایتون به فارسی 🐍💛
22

33
[![discord](https://img.shields.io/badge/Discord-python--docs--fa-5865F2?style=for-the-badge&logo=Discord)](https://discord.gg/yeqtNeaFYf)
44
[![youtube](https://img.shields.io/badge/Youtube-Contribution--Guide-CD201F?style=for-the-badge&logo=Youtube)](https://www.youtube.com/watch?v=DH5c5ZutTCo)
55

6-
## درباره پروژه
6+
## دربارهٔ پروژه
77

8-
ما توی این پروژه گروهی از علاقه‌مندان به پایتون هستیم که روی ترجمه مستندات رسمی پایتون به فارسی می‌کنیم. هدف ما این است که حتی کاربرانی که تسلط کامل به زبان انگلیسی ندارند، بتوانند با استفاده از راهنمایی‌های دقیق و به‌روز، اصول برنامه‌نویسی پایتون را به راحتی یاد بگیرند.
8+
این پروژه گروهی از علاقه‌مندان به پایتون است که مستندات رسمی پایتون را به فارسی ترجمه می‌کنند. هدف این است که کاربرانی که تسلط کاملی به زبان انگلیسی ندارند نیز بتوانند با استفاده از راهنمایی‌های دقیق و به‌روز، اصول برنامه‌نویسی پایتون را به‌راحتی یاد بگیرند.
99

1010
## مجوز
1111

1212
ترجمه‌ها مطابق [PEP 545](https://peps.python.org/pep-0545/) تحت مجوز [CC0 1.0 Universal](LICENSE) منتشر می‌شوند؛ یعنی در مالکیت عمومی (Public Domain) قرار دارند و می‌توانید بدون هیچ محدودیتی از آن‌ها استفاده، کپی و بازنشر کنید.
1313

1414
## راهنمای مشارکت 🌱
1515

16-
ترجمه‌ها دیگر روی Transifex انجام نمی‌شوند و مستقیماً از طریق پول‌ریکوئست در همین ریپازیتوری مدیریت می‌شوند. فایل‌های `.po` هر کدام به بخشی از مستندات پایتون (مثل `tutorial/`، `library/` یا `c-api/`) مربوط‌اند و می‌توانید هرکدام را جداگانه ویرایش و پول‌ریکوئست بزنید.
16+
ترجمه‌ها دیگر روی Transifex انجام نمی‌شوند و مستقیماً از طریق پول‌ریکوئست در همین مخزن (Repository) مدیریت می‌شوند. فایل‌های `.po` هر کدام به بخشی از مستندات پایتون (مثل `tutorial/`، `library/` یا `c-api/`) مربوط‌اند و می‌توانید هرکدام را جداگانه ویرایش و پول‌ریکوئست بزنید.
1717

18-
خلاصه فرایند مشارکت:
18+
خلاصهٔ فرایند مشارکت:
1919

20-
1. ریپازیتوری را فورک و کلون کنید.
21-
2. فایل `.po` مورد نظر رو با [Poedit](https://poedit.net/) باز کنید (رشته‌های ترجمه‌نشده یا fuzzy را می‌توانید از پنل فیلتر پیدا کنید).
22-
3. متن انگلیسی (`msgid`) را ترجمه کنید و در بخش ترجمه (`msgstr`) وارد کنید.
23-
4. نشانه‌گذاری‌های Sphinx مثل `` :class:`int` ``، `` :func:`repr` ``، `` ``code`` ``، و جای‌گزین‌هایی مثل `%s` یا `{name}` را دقیقاً بدون تغییر نگه دارید؛ فقط متن اطراف آن‌ها ترجمه می‌شود.
24-
5. پیش از ارسال پول‌ریکوئست، بررسی کنید فایل‌ها مشکلی ندارند:
25-
```bash
20+
1. مخزن را فورک و کلون کنید.
21+
2. اگر ایشیوی مربوط به فایل مورد نظرتان باز نشده، یک ایشیوی «درخواست ترجمهٔ صفحه» باز کنید تا دیگران بدانند آن فایل در حال انجام است.
22+
3. فایل `.po` مورد نظر را با [Poedit](https://poedit.net/) باز کنید (رشته‌های ترجمه‌نشده یا `fuzzy` را می‌توانید از پنل فیلتر پیدا کنید).
23+
4. متن انگلیسی (`msgid`) را ترجمه کنید و در بخش ترجمه (`msgstr`) وارد کنید. ترجمه باید در سطح رسمی و با خطاب «شما» نوشته شود.
24+
5. نشانه‌گذاری‌های Sphinx مثل `` :class:`int` ``، `` :func:`repr` ``، `` ``code`` ``، و جای‌گزین‌هایی مثل `%s` یا `{name}` را دقیقاً بدون تغییر نگه دارید؛ فقط متن اطراف آن‌ها ترجمه می‌شود.
25+
6. پیش از ارسال پول‌ریکوئست، بررسی کنید فایل‌ها مشکلی ندارند:
26+
```bash
2627
msgfmt --check your_file.po
2728
python3 scripts/check_markup.py your_file.po
28-
```
29-
6. پول‌ریکوئست را باز کنید — روی هر پول‌ریکوئست به‌صورت خودکار بررسی‌های لازم اجرا می‌شود.
29+
```
30+
7. پول‌ریکوئست را باز کنید (حداکثر تا ۴ فایل `.po` در هر پول‌ریکوئست) — روی هر پول‌ریکوئست به‌صورت خودکار بررسی‌های لازم اجرا می‌شود و ری‌دتردکس (Read the Docs) نسخهٔ پیش‌نمایش مستندات را می‌سازد. اگر بررسی‌ها رد شدند، از تب Actions در گیت‌هاب ببینید کدام مورد مشکل داشته و همان اسکریپت را به‌صورت محلی اجرا کنید.
3031

3132
برای دیدن این‌که کدام فایل‌ها هنوز نیاز به ترجمه دارند و چقدر از هرکدام باقی مانده:
3233
```bash
3334
python3 scripts/translation_status.py --only-incomplete
3435
```
3536

37+
راهنمای کامل‌تر این مراحل، از جمله نکات نگارشی و تایپوگرافی فارسی، در [CONTRIBUTING.md](CONTRIBUTING.md) آمده است.
38+
3639
### منابع پیشنهادی
3740

38-
قبل از شروع، حتماً نگاهی به این فایل‌ها بیندازید:
41+
پیش از شروع، حتماً نگاهی به این فایل‌ها بیندازید:
3942

40-
- [CONTRIBUTING.md](CONTRIBUTING.md) — راهنمای کامل مشارکت: فرایند بازبینی و تأیید پول‌ریکوئست، همگام‌سازی با نسخه‌های جدید پایتون (`scripts/update_python_version.py`)، پاک‌سازی رشته‌های `fuzzy` و نگهداری اعتبار مترجمان در سربرگ فایل‌های `.po`.
41-
- [GLOSSARY.md](GLOSSARY.md) — واژه‌نامهٔ معادل‌های فارسی اصطلاحات تخصصی؛ هنگام ترجمه باید به آن پایبند باشیم.
43+
- [CONTRIBUTING.md](CONTRIBUTING.md) — راهنمای کامل مشارکت: انواع ایشیو، نکات نگارشی و تایپوگرافی فارسی، سطح رسمیت و لحن نوشتار، اندازهٔ پول‌ریکوئست، فرایند بازبینی و تأیید پول‌ریکوئست، همگام‌سازی با نسخه‌های جدید پایتون (`scripts/update_python_version.py`)، پاک‌سازی رشته‌های `fuzzy` و نگهداری اعتبار مترجمان در سربرگ فایل‌های `.po`.
44+
- [GLOSSARY.md](GLOSSARY.md) — واژه‌نامهٔ معادل‌های فارسی اصطلاحات تخصصی؛ هنگام ترجمه باید به آن پایبند باشید.
4245
- [TEAM.md](TEAM.md) — فهرست هماهنگ‌کننده‌ها، بازبین‌ها و مترجمان به‌همراه آمار مشارکت.
4346
- [STATUS.md](STATUS.md) — جدول وضعیت ترجمهٔ فایل‌ها که به‌صورت خودکار به‌روزرسانی می‌شود.
4447

@@ -48,13 +51,15 @@ python3 scripts/translation_status.py --only-incomplete
4851

4952
## ارتباط و هماهنگی
5053

51-
برای بحث، هماهنگی و به‌روزرسانی‌های مرتبط با ترجمه، می‌توانید از کانال‌های زیر استفاده کنید:
54+
برای بحث، هماهنگی و به‌روزرسانی‌های مرتبط با ترجمه، می‌توانید از کانال‌های زیر استفاده کنید:
5255

5356
<ul dir="rtl">
5457
<li><a href="https://discord.gg/yeqtNeaFYf">Discord مستندات پایتون به فارسی</a></li>
55-
<li>بخش <a href="https://github.com/python/python-docs-fa/issues">Issues</a> در این ریپازیتوری جهت گزارش مشکلات یا پیشنهادات</li>
58+
<li>بخش <a href="https://github.com/python/python-docs-fa/issues">Issues</a> در این مخزن جهت گزارش مشکلات یا پیشنهادات؛ سه قالب موجود است: درخواست ترجمهٔ صفحه، پرسش یا پیشنهاد واژه‌نامه، و گزارش اشکال در ترجمه.</li>
5659
</ul>
5760

61+
تمام مشارکت‌کنندگان موظف‌اند از [آیین‌نامهٔ رفتاری PSF](https://www.python.org/psf/conduct/) پیروی کنند.
62+
5863
***
5964

6065
با تشکر از همراهی شما در گسترش و بهبود مستندات پایتون به زبان فارسی!
@@ -63,4 +68,4 @@ python3 scripts/translation_status.py --only-incomplete
6368
### مشارکت‌های کاربران
6469
![نمودار مشارکت‌های کاربران؛ Revisto 3984، sepehr-rs 1630، danialbehzadi 677، invincible627 358، khosro_o 63، ParhamF 41، Ariyan_Bolandi 37، nikovinix7878 13، thaghgoo 12، Ramiz_222 10](reports/contributor_stats_latest.png)
6570
(به‌روزرسانی: 2026-08-18)
66-
<!-- STATS_END -->
71+
<!-- STATS_END -->

0 commit comments

Comments
 (0)