Skip to content

Commit d6fcceb

Browse files
committed
Update README.md
1 parent 67f7ad1 commit d6fcceb

1 file changed

Lines changed: 3 additions & 25 deletions

File tree

README.md

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

3-
[![discord](https://img.shields.io/badge/Discord-python--docs--fa-5865F2?style=for-the-badge&logo=Discord)](https://discord.gg/yeqtNeaFYf)
3+
[![discord](https://img.shields.io/badge/Telegram-python--docs--fa-00a5e0?style=for-the-badge&logo=telegram)](https://t.me/python_docs_farsi)
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

66
## دربارهٔ پروژه
@@ -11,30 +11,8 @@
1111

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

14-
## راهنمای مشارکت 🌱
15-
16-
ترجمه‌ها دیگر روی Transifex انجام نمی‌شوند و مستقیماً از طریق پول‌ریکوئست در همین مخزن (Repository) مدیریت می‌شوند. فایل‌های `.po` هر کدام به بخشی از مستندات پایتون (مثل `tutorial/`، `library/` یا `c-api/`) مربوط‌اند و می‌توانید هرکدام را جداگانه ویرایش و پول‌ریکوئست بزنید.
17-
18-
خلاصهٔ فرایند مشارکت:
19-
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
27-
msgfmt --check your_file.po
28-
python3 scripts/check_markup.py your_file.po
29-
```
30-
7. پول‌ریکوئست را باز کنید (حداکثر تا ۴ فایل `.po` در هر پول‌ریکوئست) — روی هر پول‌ریکوئست به‌صورت خودکار بررسی‌های لازم اجرا می‌شود و ری‌دتردکس (Read the Docs) نسخهٔ پیش‌نمایش مستندات را می‌سازد. اگر بررسی‌ها رد شدند، از تب Actions در گیت‌هاب ببینید کدام مورد مشکل داشته و همان اسکریپت را به‌صورت محلی اجرا کنید.
31-
32-
برای دیدن این‌که کدام فایل‌ها هنوز نیاز به ترجمه دارند و چقدر از هرکدام باقی مانده:
33-
```bash
34-
python3 scripts/translation_status.py --only-incomplete
35-
```
36-
37-
راهنمای کامل‌تر این مراحل، از جمله نکات نگارشی و تایپوگرافی فارسی، در [CONTRIBUTING.md](CONTRIBUTING.md) آمده است.
14+
## راهنمای مشارکت
15+
راهنمای کامل مشارکت به پروژه، از جمله نکات نگارشی و تایپوگرافی فارسی، در [CONTRIBUTING.md](CONTRIBUTING.md) آمده است.
3816

3917
### منابع پیشنهادی
4018

0 commit comments

Comments
 (0)